Clés API

Une clé API permet à un autre programme d'utiliser l'API AurionAI pour votre organisation. Chaque clé possède une liste d'autorisations, appelées portées (scopes). Une clé ne peut effectuer que ce que ses portées autorisent.

Disponibilité : tous les profils. Administrateurs uniquement.

Prérequis

• Vous avez le rôle Propriétaire ou Administrateur. Les autres utilisateurs voient Accès refusé.
• Vous savez ce que le programme doit faire, afin de ne lui accorder que les portées dont il a besoin.

Ouvrir les clés API

1. Dans la barre latérale, sélectionnez Paramètres.
2. Ouvrez la catégorie Système.
3. Sélectionnez Clés API.

Le tableau Clés actives affiche le nom, le début de la clé, les portées, le statut, la date de création, la dernière utilisation et la date d'expiration de chaque clé. Les clés révoquées sont répertoriées sous Clés révoquées.

Créer une clé

1. Sélectionnez Créer une clé.
2. Dans Nom, saisissez un nom indiquant quel programme utilise la clé.
3. Facultatif : dans Description (facultatif), décrivez l'utilisation de la clé.
4. Dans Expiration, choisissez la date d'expiration de la clé. La valeur par défaut est 90 jours. Vous pouvez également choisir Aucune expiration.
5. Sous Autorisations, sélectionnez les portées. Une case à cocher de groupe sélectionne toutes les portées du groupe.
6. Sélectionnez Créer une clé.
7. Copiez la clé avec Copier la clé API. AurionAI affiche la clé complète une seule fois.
8. Sélectionnez Je l'ai copiée — fermer.

Le programme envoie la clé dans l'en-tête X-API-Key de chaque requête. Une clé commence par itsm_sk_live_, ou par itsm_sk_test_ pour une organisation sandbox.

Portées

Remarques sur les portées :

• Pour publier des articles de base de connaissances avec des images, une clé a besoin de kb:read, kb:write et kb:media. Avec uniquement kb:read et kb:write, elle ne peut pas téléverser des images. Il n'existe pas de portée pour supprimer des articles.
• Pour exporter la transcription d'un appel, une clé a besoin de conversations:read, conversations:write et conversations:export ; les clés créées avant l'existence de conversations:export ne peuvent pas exporter tant que vous ne créez pas une clé de remplacement incluant cette portée.
• Il n'existe pas de portée « toutes les autorisations ». Sélectionnez chaque portée dont le programme a besoin.

Faire pivoter une clé

Faites pivoter une clé lorsque vous pensez qu'une autre personne la connaît.

1. Dans la colonne Actions de la clé, sélectionnez Faire pivoter la clé.
2. Dans la boîte de dialogue Faire pivoter la clé API, sélectionnez Faire pivoter la clé.
3. Copiez la nouvelle clé. L'ancienne clé cesse de fonctionner. Mettez à jour le programme avec la nouvelle clé.

La nouvelle clé conserve le nom, les portées et la date d'expiration de l'ancienne.

Révoquer une clé

1. Dans la colonne Actions de la clé, sélectionnez Révoquer la clé.
2. Dans la boîte de dialogue Révoquer la clé API, sélectionnez Révoquer la clé.

Le message Clé API révoquée s'affiche. Les programmes qui utilisent la clé perdent immédiatement l'accès. Cette action est irréversible.

Résultat

Une nouvelle clé fonctionne immédiatement, avec ses portées uniquement. La colonne Statut affiche Active, Expire bientôt durant les sept derniers jours avant l'expiration, Expirée ou Révoquée.

En cas de problème

• Sélectionnez au moins une autorisation Sélectionnez au moins une portée.
• Échec de la création de la clé API Réessayez. Si l'échec persiste, contactez le support AurionAI. Consultez Obtenir de l'aide.
• Secret indisponible AurionAI n'a pas affiché la clé. N'utilisez pas cette clé. Révoquez-la et créez-en une nouvelle.
• Vous avez perdu la clé. AurionAI ne peut plus l'afficher. Faites pivoter la clé ou créez-en une nouvelle.
• Une requête utilisant la clé est refusée. La clé ne dispose pas de la portée requise pour cette requête, ou elle est expirée ou révoquée. Vérifiez les colonnes Portées et Statut.
• Un programme ne peut pas téléverser des images dans la base de connaissances. Ajoutez kb:media : créez une nouvelle clé avec kb:read, kb:write et kb:media.

Articles connexes

• API développeur : utilisation et webhooks
• Connecter vos outils ITSM et CS
• Obtenir de l'aide