Passer au contenu principal

​
Rechercher une clé API

Vous pouvez utiliser la barre de recherche pour trouver facilement la clé API que vous recherchez

​
Liste des Clés API

Dans la section Admin/Document, vous pouvez consulter une liste complète de toutes les clés API avec les détails suivants :
  • Préfixe : Une séquence de caractères qui identifie le type, l’origine ou la portée de la clé API.
  • Nom Unique : Le nom unique associé à la clé API.
  • Créée : La date de création de la clé API.
  • Expire : La date d’expiration de la clé API.
  • A Expiré : Indique si la clé API est encore active. (Rouge = - Clé encore active ; Vert = Expirée)
  • Révoquée : Indique si la clé API a été désactivée. (Rouge = Clé active ; Vert = Clé révoquée)
Vous pouvez supprimer une ou plusieurs clés API en utilisant le menu déroulant “Action”.

​
Affichage des Détails d’une Clé API

Lorsque vous accédez aux détails d’une clé API spécifique, vous verrez les informations suivantes :
  • Rôles : Choisissez parmi trois rôles qui déterminent les permissions pour la clé API : Clé API Standard, Clé API Admin, Clé API Projet
  • Modèles Autorisés : Spécifiez si la clé API peut accéder à un ou plusieurs modèles de la liste disponible.
  • Compétences Autorisées : Cette fonctionnalité n’est pas encore active.
  • Opt-In : Un paramètre de confidentialité qui détermine si l’utilisation de l’API est suivie. Si la case opt-in est décochée, aucune donnée d’utilisation ne sera enregistrée.
  • Utilisateur : Chaque clé API est liée à un utilisateur spécifique. Vous pouvez réassigner la clé API à un autre utilisateur si nécessaire.
  • Préfixe : Une séquence de caractères qui identifie le type, l’origine ou la portée de la clé API (générée automatiquement lors de la création et non modifiable).
  • Nom : Un nom unique pour la clé API, généré lors de la création et non modifiable.
  • Révoquée : Indique si la clé API a été révoquée. Une fois révoquée, elle ne peut pas être réactivée.
  • Expire : Indique la date d’expiration de la clé API. Une fois expirée, la clé n’est plus utilisable.

​
Modifier/révoquer une clé API

Pour modifier ou révoquer une clé API, cliquez sur son préfixe dans la liste. Vous pouvez modifier sa date et heure d’expiration, son nom, son rôle, ses permissions (y compris les modèles et compétences), et l’utilisateur associé.

​
Supprimer une Clé API

Vous pouvez supprimer définitivement une clé API depuis sa page de détails. Notez que cette action est irréversible.

​
Créer une Nouvelle Clé API

Pour créer une nouvelle clé API, cliquez sur le bouton “Ajouter une Clé API” et remplissez les détails suivants :
  • Expire : Définissez la date et l’heure d’expiration de la clé API (optionnel ; non modifiable après création).
  • Nom : Un nom défini par l’utilisateur pour la clé API (50 caractères max ; ne doit pas être unique).
  • Rôles : Sélectionnez l’un des trois rôles impactant les permissions de la clé API : Clé API Standard (utilisation autonome), Clé API Admin (accès administrateur), Clé API Projet (Application/service web)
  • Modèles Autorisés : Spécifiez si la clé API peut appeler un ou plusieurs modèles de la liste disponible.
  • Compétences Autorisées : Cette fonctionnalité n’est pas encore active.
  • Opt-In : Un paramètre de confidentialité pour déterminer si l’utilisation de la clé API est suivie. Si la case opt-in est décochée, aucune donnée d’utilisation ne sera enregistrée.
  • Utilisateur : La clé API doit être associée à un utilisateur, et vous pouvez l’assigner à un autre utilisateur si nécessaire.
Pour créer une nouvelle clé API, cliquez sur le bouton “Ajouter une Clé API” en haut à droite ou directement sur “Ajouter” à côté de “Clés API” dans la barre latérale gauche du panneau d’administration. Après avoir défini vos paramètres souhaités et cliqué sur enregistrer, n’oubliez pas de sauvegarder la clé API affichée dans la bannière en haut de votre écran ; elle ne sera plus visible par la suite.
N’oubliez pas de sauvegarder la clé API affichée dans la bannière en haut de votre écran après la création ; elle ne sera plus visible par la suite.