Aller au contenu

Clés API

Résumé

Une clé API donne un accès programmatique à vos jobs et devices. Vous créez et gérez vos clés depuis la page Clés API du portail web.

Créer une clé

  1. Ouvrez le portail web -> Clés API.
  2. Cliquez sur Générer une clé API.
  3. Remplissez :
    • Nom - un libellé pour reconnaître la clé (ex : CI production).
    • Permissions - un ou plusieurs scopes (voir ci-dessous).
    • Expiration - date optionnelle ; laisser vide pour une clé sans expiration.
  4. Cliquez sur Générer.

La clé complète n'est affichée qu'une seule fois. Copiez-la immédiatement et stockez-la dans un endroit sûr (gestionnaire de secrets, credentials CI...). Elle ne pourra plus jamais être réaffichée.

Une clé ressemble à :

amk_live_3f2a8b1c9d2e4f5a6b7c8d9e0f1a2b3c

Permissions (scopes)

Une clé porte un ou plusieurs scopes - principe du moindre privilège.

Scope Autorise
READ Lecture seule (jobs, devices, exécutions)
TRIGGER Déclencher des exécutions
ADMIN Accès complet

Un endpoint exige un scope précis. Par exemple, lancer un job nécessite le scope TRIGGER - une clé en READ seule sera refusée.

Expiration

  • Si vous définissez une date d'expiration, la clé cesse de fonctionner pile à sa date d'expiration - aucune action manuelle nécessaire.
  • Une clé expirée est refusée avec API key is expired (voir les codes d'erreur).

Révoquer une clé

Depuis la page Clés API, cliquez sur Supprimer à côté d'une clé. La clé est immédiatement invalidée - toute intégration qui l'utilise cesse de fonctionner.

Notes de sécurité

  • Une clé n'accède qu'aux ressources de son propriétaire - jamais celles d'un autre.
  • La clé est stockée hashée sur le serveur ; en cas de fuite de la base, les clés ne pourraient pas être récupérées.
  • Traitez une clé comme un mot de passe : ne la committez jamais, ne la partagez jamais.