Clés API

L'onglet Clés API est l'endroit où vous pouvez générer et étiqueter des clés API pour vous connecter aux fonctionnalités de la plateforme par programmation. Utilisez ces clés pour établir et maintenir des connexions avec d'autres services. Nous vous recommandons d'examiner régulièrement vos clés API et de supprimer celles qui ne sont plus nécessaires pour protéger votre projet contre les accès non autorisés.

Note

Les clés API sont spécifiques à un projet et fournissent un accès aux ressources du projet. Gardez-les sécurisées et faites-les tourner régulièrement.

Liste des clés API

La liste des clés API affiche toutes les clés créées pour ce projet. Utilisez le champ Rechercher par nom ou clé pour trouver une clé spécifique. Chaque entrée affiche les colonnes suivantes :

Colonne	Description
Nom	Le nom attribué à la clé API, avec un badge indiquant son type (Privilégiée ou Système).
Clé API	Un aperçu tronqué de la valeur de la clé. Utilisez l'icône de copie pour copier la clé complète dans votre presse-papiers.
Créée	La date et l'heure de création de la clé.
Actions	Un lien Supprimer pour les clés créées par l'utilisateur. Les clés système affichent Protégée et ne peuvent pas être supprimées.

Types de clés

Lors de la création d'une nouvelle clé API, vous devez sélectionner l'un des types de clés suivants :

Type	Description
Clé privilégiée	Accès complet au projet. Peut envoyer des chats et modifier ou supprimer les ressources du projet, les agents, les workflows et les paramètres. Utilisez-la pour les intégrations de confiance et l'automatisation serveur à serveur.
Clé de visualisation bloquée	Accès en lecture seule au projet plus runtime de chat (interaction bot). Ne peut pas modifier ou supprimer les ressources du projet, les agents, les workflows ou les paramètres. Destinée à une distribution de portée limitée telle que Teams ou l'authentification d'un bot de canal.

Créer une nouvelle clé API

1. Ouvrir le formulaire Créer une clé API

   Dans l'onglet Paramètres → Clés API, sélectionnez le bouton Créer une clé API.

2. Sélectionner un type de clé

   Choisissez Clé privilégiée ou Clé de visualisation bloquée selon le niveau d'accès requis.

3. Nommer la clé

   Entrez un nom descriptif dans le champ Nom de la clé qui identifie clairement l'objectif de la clé.

4. Générer la clé

   Sélectionnez le bouton Générer. La clé sera créée et apparaîtra dans la liste des clés API.

attention

Copiez et stockez sécurisées votre clé API immédiatement après sa génération. La valeur complète de la clé peut ne pas être affichée à nouveau.

Supprimer une clé API

La clé Automator est une clé système créée automatiquement pour chaque projet et ne peut pas être supprimée. Toutes les autres clés API que vous créez peuvent être supprimées selon vos besoins.

1. Dans l'onglet Paramètres → Clés API, sélectionnez le lien Supprimer pour la clé que vous souhaitez supprimer.
2. Confirmez la suppression dans la fenêtre contextuelle.

Un message de succès confirmera la suppression et la clé ne s'affichera plus dans la liste.

Bonnes pratiques

1. Utiliser le bon type de clé : Utilisez les clés privilégiées uniquement pour les intégrations côté serveur de confiance. Utilisez les clés de visualisation bloquées pour les déploiements de bots publics ou de canal.
2. Nommage clair : Utilisez des noms descriptifs qui indiquent clairement l'objectif d'une clé et l'intégration à laquelle elle appartient.
3. Faire tourner régulièrement : Supprimez et régénérez les clés périodiquement pour réduire le risque d'accès non autorisé.