Web Portal Integration

FibriCheck offers a web portal for healthcare professionals to manage patients that are performing measurements. It's possible to redirect users to a specific page within the portal without that user having to login, using a pre-generated link that contains authentication information.

Possible use cases for this feature are:

  • Easy redirect - redirect users from the patient record software directly to the correct page in the FibriCheck Portal, without the user having to login.

  • Context Integration - by using the URL, the FibriCheck Web Portal can be easily embedded in third-party software through an iFrame.

Structure of the redirect URL

The image below shows the important parts of the redirect URL:

In the following URL, the parts that need to be replaced are indicated with curly brackets {{ }}:

https://pages.dev.fibricheck.com/consume_ssotoken/?ssoToken={{token}}&redirect=https%3A%2F%2Fpages.dev.fibricheck.com%2Fportal%2F%23%2Fpatients%{{userId}}%2Fdetails%2Foverview

How to generate an SSO token?

POST /auth/v2/oauth1/ssoTokens/generate

Executing this endpoint will generate a single sign-on token for the authenticated user. The endpoint does not require a body. This endpoint requires being authenticated in through an OAuth1.0 application.

Response

{
    "userId": "6422a0d97db02e7197c8dfcf",
    "createdByApplicationId": "5811ccc246e0fb0006efdc8d",
    "ssoToken": "bc7a175f3e36b7a84aacfcf98428d1ed61d54800",
    "updateTimestamp": "2024-08-12T09:30:57.778Z",
    "creationTimestamp": "2024-08-12T09:30:57.778Z",
    "id": "66b9d651e18f465bbdf5ad7f"
}

Additional Remarks

  • There are two options for the underlying account that is used to generate the single sign-on token

    • HCP Credentials: the HCP FibriCheck credentials are stored in the third-party platform and used to generate the token

    • Integration System Account: a dedicated system account is created that is used specifically for the integration to redirect users to the portal.

PreviousApp-to-app integrationNextIntroduction

Last updated