Bingli documentation

Welcome to the Bingli API Integration Guide.

This document is designed to provide a comprehensive guide for individuals and organizations seeking to integrate with Bingli's advanced API services. Bingli offers a seamless and efficient way for healthcare providers and systems to enhance patient engagement and streamline medical consultations through digital surveys and patient information management

API

Authentication

How to start with this document?

The best way to start with this integration is by clicking the right top and selecting "Run in postman", this makes a clone of the complete collection where you should only adapt the values.

Key Parameters Overview

Integrating with the Bingli API involves a series of parameters that must be correctly configured to ensure a successful and seamless integration. This section provides an overview of all the essential parameters you will need to set up and utilize the Bingli API effectively.

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 the specific tenant.
- Example: 3955a7c5-5804-4bab-bfb0-c1aac4f12f5a

User/password:
- Description: A user account with password for request a valid JWT token
- Usage: Required for authentication in API requests.

Healthcare Service ID (HCS_ID):
- Description: A unique identifier for each healthcare service or category provided by an organization.
- Usage: Used to specify the particular service in API requests.
- Note: This is unique per tenant

POSTFetch bearer token

https://boss.api.bingli.eu/security-api/token

Description

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

Request

credentialType: An integer representing the type of credential, e.g., 10. is password

account: The email address. Replace with the actual email.

credential: The password. Replace with the actual password.

tenantId: The tenant ID retreived from the Bingli system. Replace with the actual tenant ID.

HEADERS

Content-Type

application/json

Bodyraw (json)

json

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

Example Request

curl

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>
}'

200 OK

Example Response

json

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJCaW5nbGkiLCJpYXQiOiIxNjg0ODM1MTIzLjU5ODA3MjgiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IldpemFyZCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJXaXphcmQiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9lbWFpbGFkZHJlc3MiOiJXaXphcmQiLCJVc2VySWQiOiIwOTY0NWMwNC1lZjRmLTQwMDQtYWQ4MS0xZTA1OTM4NTA2MTkiLCJVc2VyUmlnaHRzIjoiMDEwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiwiVGVuYW50SWQiOiIiLCJIZWFsdGhDYXJlU2VydmljZUlkIjoiIiwiQ2xpZW50SWQiOiJCaW5nbGlVbml2ZXJzZSIsImV4cCI6MTY4NDg3ODMyMywiaXNzIjoiaHR0cHM6Ly9hcHAtYm9zcy10ZXN0LmF6dXJld2Vic2l0ZXMubmV0IiwiYXVkIjoiTXlCaW5nbGkifQ.Ob95u_0cA_cwoM5_h_JDbyaTJUo2ujIYYJROewarY7Q",
    "refreshToken": "IuTLeBgFB3IxnZPmpsVP0KtK5grlsuLWNSwBtmeTRVIQf12BxsTZdGuYOzRyIfjvvTsKCOzyYWKXrtbMNvZLA"
  },
  "responseType": 200,
  "responseMessages": [
    "Sucessfully created Bingli.Core.Data.Security.JwtToken"
  ]
}

Content-Type

application/json; charset=utf-8

Date

Tue, 23 May 2023 09:45:23 GMT

Server

Kestrel

Transfer-Encoding

chunked

Request-Context

appId=cid-v1:5f968d63-16b7-4b62-80da-910bf8dc4f4e