Aller au contenu
ReigniterDocs
Retour au site

Authentification

Le Reigniter API utilise API clés. Chaque clé appartient à un compte et agit comme ce compte : elle dépense les crédits de ce compte et ne voit que les tâches de ce compte.

API clés font partie du plan Agency.

  1. Connectez-vous à Reigniter.
  2. Compte ouvert > API clés (/app/account/api-keys).
  3. Dans Créer une nouvelle clé, tapez une étiquette que vous reconnaîtrez plus tard, comme CI pipeline ou CMS sync.
  4. Sélectionne Créer.
  5. Copiez la clé immédiatement.

Une clé ressemble à ceci : emp_ suivie de 64 caractères hexadécimaux.

Placez la clé dans l’en-tête Authorization en tant que jeton porteur à chaque requête :

Fenêtre de terminal
curl https://reigniter.ai/v1/me \
-H "Authorization: Bearer $REIGNITER_API_KEY"

Une clé valide renvoie 200 avec votre compte :

{
"user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21",
"email": "[email protected]",
"name": "Sam",
"credits_remaining": 42
}
Statut code Signification
401 NO_API_KEY Pas d’en-tête Authorization, ou le jeton ne commence pas par emp_.
401 INVALID_API_KEY La clé est inconnue ou a été révoquée.
402 PLAN_UPGRADE_REQUIRED La clé est valide, mais le compte ne figure pas sur le plan Agency.
403 ACCOUNT_SUSPENDED Le compte qui possède la clé est suspendu.

Si un compte quitte le forfait Agency, ses clés cessent de fonctionner jusqu’à ce qu’il soit de nouveau sur Agency.

  • Stockez les clés dans un gestionnaire secret ou une variable d’environnement. Ne les mettez jamais en contrôle de version.
  • Appelez le API uniquement depuis votre serveur. N’envoyez jamais de clé dans une page web ou une application mobile. Les requêtes navigateur vers le API ne sont de toute façon pas autorisées par sa politique CORS.
  • Utilisez une clé par système, avec une étiquette claire. Vous pouvez alors en révoquer une sans casser les autres.
  • L’écran des API clés indique quand chaque touche a été utilisée pour la dernière fois. Une clé que vous ne reconnaissez pas, ou utilisée alors qu’elle ne devrait pas l’être, doit être révoquée.
  1. Compte ouvert > API clés.
  2. Dans les touches Actives, trouvez la clé près de son label.
  3. Sélectionnez l’icône Révoquer la clé (bin).

Une clé révoquée est refusée immédiatement avec 401 INVALID_API_KEY. La révocation ne peut pas être annulée. Les rendus déjà commencés avec la clé continuent de s’exécuter.