Gérer les clés API
Les clés API authentifient les requêtes vers l'API Ferndesk. Lorsque vous créez une clé, choisissez un préréglage d'accès ou des portées personnalisées afin que la clé n'obtienne que les autorisations dont elle a besoin.
Considérez chaque clé comme un secret. Ne commitez jamais de clés dans le contrôle de version. Révoquez immédiatement une clé si elle est exposée.
Créer une clé API
Cliquez sur API dans la barre latérale gauche, sous Developers.
Cliquez sur New API key.
Saisissez un Key name (par exemple, Production ou CI/CD pipeline).
Sous Permissions, choisissez un préréglage :
Full access - Lire, écrire et publier du contenu, ainsi que les analyses, les conversations IA et les webhooks.
Read only - Lire le contenu, les analyses et les conversations IA. Ne peut rien modifier.
Custom - Sélectionnez des portées individuelles à l'aide des cases à cocher ci-dessous.
Cliquez sur Create key.
Dans Save your API key, copiez la valeur sous Your new API key, puis cliquez sur Done.
Cette clé ne sera plus affichée. Copiez-la dans un endroit sûr avant de fermer la boîte de dialogue.
Portées personnalisées
Lorsque vous choisissez Custom, sélectionnez une ou plusieurs de ces autorisations :
Autorisation | Ce qu'elle permet |
|---|---|
Lire le contenu | Articles, collections, révisions, traductions |
Écrire du contenu | Créer et modifier des brouillons, des collections, déplacer des articles, mettre à la corbeille |
Publier | Rendre les brouillons visibles, dépublier, restaurer des révisions |
Lire les analyses | Rapports et retours sur les articles |
Lire les conversations IA | Transcriptions des conversations des utilisateurs finaux |
Gérer les webhooks | Enregistrer et gérer des points de terminaison webhook |
La sélection de Write content ou Publish inclut toujours Read content. La case de lecture reste cochée et affiche Required by Write content and Publish. Vous devez sélectionner au moins une autorisation avant de pouvoir créer une clé personnalisée.
Afficher vos clés API
Toutes les clés apparaissent sur la page API avec le nom de la clé, le créateur, la date de création, la date de dernière utilisation et les badges de portée.
Les clés avec portées affichent de petits badges comme read, write, publish, analytics, conversations et webhooks.
Les clés créées avant l'existence des autorisations affichent Legacy · full access. Ces clés se comportent comme un accès complet et utilisent l'ancien format de réponse de l'API. Faites-les pivoter pour adopter les autorisations.
Le secret complet de la clé n'est jamais affiché à nouveau après sa création.
Révoquer une clé API
Accédez à la page API.
Ouvrez le menu à côté de la clé et sélectionnez Revoke.
Confirmez dans la boîte de dialogue Revoke API key.
La révocation d'une clé bloque immédiatement toutes les requêtes qui l'utilisent.
Faites pivoter régulièrement les clés et révoquez celles qui ne sont pas utilisées. Préférez Read only ou un ensemble Custom minimal lorsqu'un workflow n'a pas besoin d'un accès en écriture ou en publication.
Pour savoir comment envoyer une clé dans les requêtes API, consultez Authentication.