Using the Partner API

Integration basics

The simplest form of integration involves a backend solution calling the Partner API on its own behalf. Upon onboarding, you will receive a client_id and client_secret, which are essential for the Client Credentials Flow. These credentials are used to obtain a short-lived access token, which must accompany subsequent API requests.

Danger

The client_id and client_secret are unique to your solution and one of our environments. You will have at least two sets: one for testing and one for production.

These credentials must be kept secure and are only suitable for specific scenarios. For more information, see Authentication.

Obtaining a token

To obtain a token using the Client Credentials Flow you need to make a call to our OIDC/OAuth compliant Identity Provider (IdP). Please see Authentication.

Calling the Partner API

With an access token obtained, you can now make a call to the Partner API. For example, to retrieve a medical record:

curl -X GET "https://XXXXXXX/api/medicalRecord/GetMedicalRecord?patientNumber=XXXXXXX" \
  -H "ApplicationId: XXXXXXX" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."