Authentication

Platform’s external API uses API keys to authenticate requests. API keys can be managed in the Back Office of your platform from the Settings > Advanced page.

If you don’t have admin access to your platform, you can contact your BeMyApp project manager in order to get an API key.

API key

Authentication to the API is performed by using your API key as a Bearer token in Authorization header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
API requests without authentication will also fail.

Sample API key: IDT_9561c43519...c2c0552199a6b0.

Sample request to the external API using cURL

curl --request GET \
  --url 'https://{PLATFORM_URL}/api/external/v1/talk/upcoming' \
  --header 'Authorization: Bearer {API_KEY}' \
  --header 'Content-Type: application/json;charset=utf-8'

Limitation

Privilege level

API keys have privilege level, allowing fine-grained access control of each endpoint of the API.
API keys starting with IDT_ have standard privilege level and therefore will not be able to use endpoints labeled as Restricted.

Rate Limit

Platform’s external API is limited to 100 requests per minute. Passed this limit the API will return an error.

Authentication errors

Code	Error message	Description
401	Missing Authorization header	Authorisation header was not provided or not properly passed to the request
401	Invalid API key	No valid API key was provided
403	Access denied: Insufficient permissions.	API key is not allowed to use the targeted endpoint.
429	Too many requests, please try again later.	API limitation has been reached, wait before making new requests.