Gérer les clés API

La page Gestion des clés de la console d'administration Clovis centralise les clés API de l'organisation sélectionnée. Elle permet de suivre leur consommation et de gérer leur cycle de vie.

Vérifiez l'organisation sélectionnée

Si votre compte donne accès à plusieurs organisations, vérifiez le sélecteur situé en haut à gauche avant de créer ou de modifier une clé. Les changements s'appliquent à l'organisation actuellement affichée.

Consulter et retrouver une clé

Le nombre total de clés apparaît à côté du titre Clés API. Le tableau présente, pour chaque clé :

Colonne	Information affichée
Alias	Nom permettant d'identifier l'usage de la clé, accompagné d'un fragment masqué de la clé.
Responsable	Personne ou équipe associée à la clé.
Tokens	Volume de jetons consommé par la clé.
Créée le	Date de création de la clé.
Statut	État actuel de la clé, par exemple Active.
Action	Menu donnant accès aux opérations disponibles sur la clé.

Utilisez le champ Rechercher par alias ou responsable pour filtrer la liste. Lorsque le nombre de résultats dépasse une page, utilisez la pagination située sous le tableau.

Créer une clé

1. Sélectionnez Créer une clé.
2. Dans Alias de la clé, saisissez un suffixe court qui décrit clairement l'application, l'environnement ou l'usage concerné. Le nom complet affiché tient compte du préfixe ajouté par la console.
3. Dans Email du responsable, sélectionnez un utilisateur existant ou saisissez l'adresse professionnelle de la personne responsable. Si elle n'existe pas encore dans Clovis, un compte est créé pour cette adresse.
4. Vérifiez le nom complet et le responsable, puis sélectionnez Créer la clé.
5. Transmettez et stockez la clé selon les règles de sécurité de votre organisation.

Protégez la valeur de la clé

Une clé API est un secret. Ne l'insérez jamais dans le code source, la documentation, une capture d'écran, un ticket ou un message non sécurisé. Stockez-la dans un gestionnaire de secrets et remplacez-la immédiatement si elle a été exposée.

Choisissez un alias stable et explicite, par exemple exemple-production ou exemple-ci. Évitez les noms de personnes et créez une clé distincte par application et par environnement afin de faciliter le suivi et la révocation.

Gérer une clé existante

Ouvrez le menu ⋮ dans la colonne Action de la clé concernée.

Action	Effet	Point d'attention
Définir une limite	Fixe une consommation maximale, exprimée en millions de jetons, pour la période sélectionnée.	Avec la période À vie, la clé cesse définitivement de fonctionner une fois la limite atteinte.
Protéger la clé	Protège la clé contre une suppression accidentelle.	Utilisez cette option pour les clés nécessaires à un service important.
Définir comme ChattyBot	Affecte la clé au service ChattyBot.	Vérifiez l'alias et le responsable avant de confirmer cette affectation.
Bloquer la clé	Désactive immédiatement la clé, qui ne peut alors plus être utilisée.	Les applications qui l'utilisent rencontrent des erreurs d'authentification dès le blocage.
Supprimer	Supprime définitivement la clé.	Cette action est irréversible. Vérifiez d'abord qu'aucun service ne dépend encore de la clé.

Définir une limite de jetons

1. Sélectionnez Définir une limite.
2. Saisissez la limite en millions de jetons.
3. Choisissez la période proposée.
4. Lisez l'effet indiqué dans la fenêtre, puis sélectionnez Enregistrer.

Surveillez ensuite la colonne Tokens afin d'anticiper l'atteinte de la limite.

Protéger une clé

1. Sélectionnez Protéger la clé.
2. Vérifiez l'alias affiché dans la fenêtre de confirmation.
3. Sélectionnez Protéger.

La protection réduit le risque de suppression accidentelle. Elle ne remplace ni une limite de consommation ni le blocage d'une clé compromise.

Affecter une clé à ChattyBot

1. Sélectionnez Définir comme ChattyBot.
2. Vérifiez l'alias affiché.
3. Sélectionnez Définir.

La clé est alors utilisée par le service ChattyBot.

Bloquer une clé

1. Sélectionnez Bloquer la clé.
2. Vérifiez l'alias et l'impact sur les applications dépendantes.
3. Sélectionnez Bloquer.

Privilégiez le blocage lorsqu'une clé est suspectée d'avoir été exposée ou lorsque vous devez interrompre immédiatement son utilisation.

Supprimer une clé

1. Confirmez que la clé n'est plus utilisée et qu'aucune application ne dépend de sa valeur.
2. Sélectionnez Supprimer dans le menu d'actions.
3. Vérifiez l'alias affiché dans la fenêtre de confirmation.
4. Sélectionnez Supprimer.

La suppression est irréversible. Pour une interruption immédiate avant vérification, bloquez d'abord la clé.

Bonnes pratiques de gestion

• attribuez un responsable identifiable à chaque clé ;
• utilisez une clé distincte par application et par environnement ;
• définissez une limite adaptée à l'usage attendu ;
• protégez les clés indispensables contre la suppression accidentelle ;
• contrôlez régulièrement la consommation et bloquez les clés inutilisées ;
• supprimez une clé uniquement après avoir vérifié qu'aucun service n'en dépend ;
• ne publiez jamais la valeur ou un fragment reconnaissable d'une clé.

Visibilité selon les droits

Les clés, organisations et actions disponibles dépendent des permissions associées à votre compte.