# FibriCheck Connect API

The FibriCheck Connect API is a set of new API endpoints dedicated to facilitating integrations via partner platforms, intermediate integration platforms, and electronic health records (EHRs).

<figure><img src="https://550842036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1VHmKXYQVUzvBkU504K0%2Fuploads%2Fy5lbSB1att4UEA8EusBM%2Fdocs.fibricheck.com%20-%20FibriCheck%20Connect%20API.png?alt=media&#x26;token=d1966a27-f45c-4f79-9c66-4d5305333197" alt="" width="563"><figcaption></figcaption></figure>

Currently, the FibriCheck Connect API does not yet fully replace the regular FibriCheck API. We will be gradually increasing the functionality of the Connect API so that as an integration partner, you'll become less dependent on the FibriCheck API.&#x20;

The current feature set of the Connect API is:

* Facilitate integrations through the [Transmural Platform \[TMP\] ](https://www.telemonitoring-prescription.com/)in Belgium.
* Facilitate integrations with EPIC through Smart on FHIR.
* Provide an easy way to generate user-specific portal links.

## Authenticating against the Connect API

{% hint style="warning" %}
Access to the Connect API is disabled by default for our integration partners. If you want to have access, please reach out to your FibriCheck or contact us at <integrations@fibricheck.com>
{% endhint %}

The Connect API supports the same authentication as the regular API. That means that if you're authenticated against the regular API, you're also authenticated against the Connect API.&#x20;

The Connect API supports both the **OAuth1.0** and **OAuth2.0** authentication methods from the regular API.

The most important difference to keep in mind is that the hostnames are different.

<table><thead><tr><th width="66.890625"></th><th>Development</th><th>🇪🇺 EU Production</th><th>🇺🇸 US Production</th></tr></thead><tbody><tr><td>Host</td><td>connect.dev.fibricheck.com</td><td>connect.fibricheck.com</td><td>connect.us.fibricheck.com</td></tr></tbody></table>

## Generating a portal patient web view URL

In integrations, it's often required to show a patient-scoped view of FibriCheck in an external platform. To avoid having to rebuild all the FibriCheck functionalities, we offer a way to easily generate an authenticated URL that opens a patient-scoped view of the FibriCheck Portal.

{% embed url="<https://drive.google.com/file/d/1oAjgm6px4FszfygqtpMxoBorAoUM3zM6/view?usp=sharing>" %}

### API Specification

Example call:

```json
GET https://connect.dev.fibricheck.com/api/v1/integrations/integrationPartner/1234567890abcdef12345678/patient_link?userId=5811c91b46e0fb000530a46d
```

&#x20;

## Get patient link

> Get a link to the patient dashboard to review patient measurements.

```json
{"openapi":"3.0.0","info":{"title":"Fibricheck Connect API","version":"0.1.0"},"tags":[{"name":"Customers","description":"Endpoints related to customer management"}],"servers":[{"url":"https://connect.dev.fibricheck.com","description":"Development server"}],"paths":{"/api/v1/integrations/{integrationPartner}/{customerId}/patient_link":{"get":{"summary":"Get patient link","tags":["Customers"],"description":"Get a link to the patient dashboard to review patient measurements.","parameters":[{"schema":{"type":"string"},"in":"query","name":"userId","required":false,"description":"The patient user ID at FibriCheck for which you want to show the measurements."},{"schema":{"type":"string"},"in":"path","name":"integrationPartner","required":true},{"schema":{"type":"string"},"in":"path","name":"customerId","required":true,"description":"customer ID for which to query"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"format":"uri","type":"string"}},"required":["url"]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```