Aller au contenu
Vérifié

Bonnes pratiques des clés API

Accès complet ou personnalisé, révoquer et remplacer une clé, et repérer celle que personne n'utilise.

Une clé API agit sur votre compte sans vous : de n'importe où, jusqu'à sa révocation. Authentification explique comment une clé est créée et envoyée avec un appel ; cette page porte sur la manière de garder en ordre celles que vous avez déjà.

Ne donnez à une clé que ce dont elle a besoin

Chaque clé est en Accès complet ou en Accès personnalisé, choisi à sa création et modifiable plus tard depuis le même formulaire.

  • Accès complet atteint toutes les méthodes que votre compte peut appeler, y compris celles ajoutées après la création de la clé. Rien de ce qui est marqué comme privé n'est jamais inclus, quel que soit le mode d'accès d'une clé.
  • Accès personnalisé n'atteint que les méthodes que vous avez explicitement cochées, regroupées par microservice, avec les paramètres propres à chaque méthode affichés à côté. Une méthode ajoutée plus tard n'est pas couverte tant que vous ne revenez pas la cocher.
Préférez l'accès personnalisé pour tout ce qui est automatisé

Une clé intégrée à un script, à une tâche de CI ou à un serveur n'a besoin que des quelques méthodes que cette tâche appelle réellement. L'accès personnalisé empêche une clé divulguée d'en faire plus que le travail pour lequel elle a été conçue.

Créer, révéler et copier

Créer une clé exige que votre compte soit vérifié au niveau 2 ; voir Vérification. Le bouton Créer une clé l'explique et renvoie directement à la prochaine étape inachevée si vous n'y êtes pas encore. La valeur d'une clé nouvellement créée est affichée une seule fois dans le panneau Copie rapide en haut de la liste ; ensuite, chaque ligne la garde masquée, et le bouton de révélation d'une ligne l'affiche de nouveau pendant 20 secondes avant qu'elle ne se masque d'elle-même.

Une clé est un secret, pas une étiquette

La valeur n'est jamais écrite dans un journal, une notification ou la barre d'adresse, seulement dans votre presse-papiers. Traitez-la exactement comme un mot de passe. Quiconque la possède peut agir au nom de votre compte.

Remplacer, révoquer et repérer une clé inutilisée

Il n'y a pas d'action de rotation distincte, car la valeur d'une clé est son propre identifiant. Remplacer crée une nouvelle clé avec le même nom et le même accès, révoque l'ancienne et affiche la nouvelle valeur une seule fois pour que vous puissiez la copier avant de fermer la boîte de dialogue. Révoquer supprime une clé définitivement, et vous demande d'abord de la confirmer par son nom, car c'est irréversible.

La ligne de chaque clé indique quand elle a été utilisée pour la dernière fois, d'après les 7 derniers jours d'activité ; une clé sans mention en dessous n'a simplement fait aucun appel sur cette période. C'est la ligne qui mérite un second regard.

Remplacez une clé qui a pu fuiter

Ouvrez la clé, appuyez sur Remplacer et copiez la nouvelle valeur dès qu'elle apparaît. L'ancienne valeur cesse de fonctionner à l'instant où le remplacement se termine.

Révoquez une clé dont vous n'avez plus besoin

Appuyez sur Révoquer sur sa ligne et confirmez par son nom. Une clé révoquée disparaît de la liste active ; il n'y a aucun moyen de la récupérer.

Cherchez-en une que personne n'utilise

Parcourez la liste à la recherche d'une ligne sans mention « Dernière utilisation », surtout parmi les clés en Accès complet, et révoquez-la si vous ne pouvez pas expliquer son existence.