Créer une clé
- Ouvrez Paramètres, puis Clés API, et choisissez Créer une clé.
- Nommez-la d’après le système qui l’utilisera. Choisissez des autorisations et, si vous le souhaitez, une date d’expiration.
- Copiez la clé maintenant et conservez-la dans le coffre à secrets de votre système.
Important: La clé complète n’est affichée qu’une seule fois. Si vous la perdez, révoquez-la et créez-en une autre.
| Autorisations | Agit en tant que |
|---|---|
| Lecture seule | Un lecteur. Elle peut lire ce qu’un lecteur peut lire. |
| Lecture et écriture | Un gestionnaire au maximum. Elle peut créer et modifier ce qu’un gestionnaire peut créer et modifier. |
Utilisation
Envoyez la clé dans l’en-tête Authorization de chaque requête adressée à l’API de l’application :
Authorization: Bearer ehk_...
- Une clé ne fonctionne que pour sa propre organisation et uniquement dans le cadre de ses autorisations.
- Aucun en-tête CSRF n’est nécessaire avec une clé.
- Une clé ne peut ni créer ni gérer d’autres clés.
- Les requêtes effectuées avec une clé sont enregistrées dans le journal d’audit au nom de la clé API.
Révoquer
Choisissez Révoquer sur une clé et elle cesse immédiatement de fonctionner : les systèmes qui l’utilisent reçoivent alors des erreurs 401. Une clé cesse aussi de fonctionner lorsque le membre qui l’a créée quitte l’organisation. La liste indique la dernière utilisation de chaque clé.
Tip: Dans la mesure du possible, attribuez à chaque intégration sa propre clé en lecture seule. En cas de fuite, vous ne révoquez que celle-ci.
Pour obtenir la description de l’API destinée à vos développeurs, faites-en la demande via le formulaire de contact.