Clés API

Les clés API vous permettent de connecter vos applications tierces avec votre back office. Elles vous permettent de gérer et consommer les ressources de votre back office via des requêtes API au format JSON.

Composition

Une clé API se définit par un unique nom, une date d'expiration, et un ensemble de permissions.

Les permissions vous permettent définir les actions que pourra effectuer une requête utilisant cette clé API. Par exemple, lister les utilisateurs, créer une nouvelle tâche, éditer une réunion etc.

Sécurité

⚠️

Il est conseillé d'ajouter une date d'expiration à vos clés API afin de les renouveller par intervalle de temps.

Utilisation

Afin d'effectuer une requête vers l'API de votre back office, vous devez fournir la clé API via un en-tête nommé x-api-key. Voici un exemple de requête CURL qui vous permet de récupérer l'ensemble des utilisateurs au format JSON :

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

Votre clé API peut être obtenue puis copiée dans le presse-papier depuis votre interface.

Vous pouvez également décider du format des clés du retour de votre requête. Pour ce faire, vous devez envoyer un en-tête x-api-inflection qui peut prendre pour valeur camel, dash, snake ou pascal. Voici un exemple de requête CURL qui vous permet de récupérer l'ensemble des utilisateurs au format JSON camelcase :

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