English

Français
Italiano

English

Français
Italiano

Appearance

API Keys ​

API keys allow you to connect your third-party applications with your back office. They allow you to manage and consume your back office resources via API requests in JSON format.

Composition ​

An API key is defined by a unique name, an expiration date, and a set of permissions.

Permissions allow you to define the actions that can be performed by a request using this API key. For example, list users, create a new task, edit a meeting etc.

Security ​

⚠️

It's advisable to add an expiration date to your API keys so that you can renew them at intervals.

Usage ​

In order to make a request to your back office API, you need to provide the API key via a header named x-api-key. Here's an example of a CURL request that allows you to retrieve all users in JSON format:

shell
curl https://demo.back-office.pro/users \
     -H 'x-api-key: **********' \
     -H 'Accept: application/json'

Your API key can be obtained and then copied to the clipboard from your interface.

You can also decide the format of the keys in the return of your request. To do this, you need to send a x-api-inflection header which can be set to camel, dash, snake or pascal. Here's an example of a CURL request that allows you to retrieve all users in JSON camelcase format:

shell
curl https://demo.back-office.pro/users \
     -H 'x-api-key: **********' \
     -H 'x-api-inflection: camel' \
     -H 'Accept: application/json'