👩💻Developer Guide
To start developing with FibriCheck, you need to request credentials to authenticate yourself against the API. You will receive a Consumer Key, Consumer Secret , Access Token and Token Secret. These credentials are of a regular FibriCheck user with additional administrative permissions.
There is no specific protection on this administrative account. It's possible to (accidentally) delete this account. Make sure to review the userId of the administrative account and make sure to never use it in destructive requests.
Getting Started
For SDK integrations
Integrate the Camera SDK into your application to perform measurements
Use the Cloud SDK or REST API to upload the measurements to the FibriCheck cloud
For app-to-app integrations:
Review the app-to-app documentation to learn how to redirect users to the FibriCheck application from your application.
Use the Cloud SDK or REST API to access the measurements performed in the FibriCheck app
Important Remarks
All query parameters in URL's must be URL encoded
Throughout the documentation, variables in curly brackets
{}are placeholder values that need to be replaced by the value relevant to the data that you want to retrieve or create.The
{userId}always refers to the userId generated by FibriCheck when registering a new user.
FAQ
Why does a newly registered user not show up in the user listing?
As a partner, you can only see the users enrolled in a group linked to you. When a new user registers through the /register endpoint, you receive access to their information through the API when the user is enrolled in your group.
To enroll a user in your group, see the prescriptions documentation.
The API returns an insufficient balance error.
Groups have a credit system that limits the amount of prescriptions that can be activated by users in a group. When the credit balance is low, you will receive the following error: The group balance has an insufficient value to pay the subscription.
If this happens, in development or in production environments, you can request a credit balance increase through your support channel or via [email protected].
What timezones are supported?
Last updated