Skip to main content

Authentication

Key Parameters Overview​

Integrating with the Bingli API requires configuring specific parameters correctly to ensure seamless authentication and communication with the system. Below is an overview of the essential parameters needed for a successful setup.

Essential Parameters for Integration​

Tenant Reference (Tenant_ID)​

  • Description: A unique identifier provided by Bingli for each tenant.
  • Usage: Used in API requests to link the data to a specific tenant.
  • Example: 3955a7c5-5804-4bab-bfb0-c1aac4f12f5a

User/Password​

  • Description: A user account with a password is required to request a valid JWT token.
  • Usage: Necessary for authentication in API requests.

Healthcare Service ID (HCS_ID)​

  • Description: A unique identifier for each healthcare service or category within an organization.
  • Usage: Used to specify a particular service in API requests.
  • Note: This is unique per tenant.

API Environments​

Bingli provides multiple environments for different use cases:

  • Production EU: https://boss.api.bingli.eu
  • Acceptance EU: https://boss.api.acc.bingli.be
  • Production US: https://boss.api.bingli.us

Authentication Request​

POST - Fetch Bearer Token​

Endpoint​

{environment}/security-api/token

Replace {environment} with the appropriate API environment URL.

Description​

This endpoint is used for authentication, allowing a system to obtain a token by providing valid account credentials. The token is required for all subsequent API requests that require authentication.

Request Details​

Headers​

KeyValue
Content-Typeapplication/json
Acceptapplication/json

Body (Raw JSON)​

{
  "credentialType": 10,
  "account": "<EMAIL>",
  "credential": "<PASSWORD>",
  "tenantId": "<TENANTID>",
  "healthcareServiceId": "<HCS_ID>"
}

cURL Request​

To fetch a bearer token using cURL, use the following command:

authenticaion.md
curl --location 'https://boss.api.bingli.eu/security-api/token' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "credentialType": 10,
  "account": "<EMAIL>",
  "credential": "<PASSWORD>",
  "tenantId": "<TENANTID>",
  "healthcareServiceId": "<HCS_ID>"
}'

Parameters Explanation​

  • credentialType: An integer representing the type of credential. Use 10 for password authentication.
  • account: The email address associated with the account. Replace <EMAIL> with the actual email.
  • credential: The password for the account. Replace <PASSWORD> with the actual password.
  • tenantId: The tenant ID assigned by Bingli. Replace <TENANTID> with the correct value.
  • healthcareServiceId: The healthcare service ID assigned by Bingli. Replace <HCS_ID> with the correct value.

Conclusion​

Once you successfully obtain the bearer token, include it in the Authorization header for all further API requests. For more details, refer to the Bingli API Documentation or contact support@mybingli.com.