Jetons API

Chaque appel programmatique à Gaard s’authentifie avec un jeton bearer. Gaard propose deux types d’identifiants pour des usages différents : les clés API limitées à un flow, et les jetons d’accès personnels rattachés à votre utilisateur. Ce guide montre comment créer, limiter et révoquer chacun d’eux.

Prérequis

• Un compte Administrator pour gérer les clés API dans Settings → Platform → Integrations.
• La CLI gaard installée si vous souhaitez créer des jetons d’accès personnels.

Quel identifiant utiliser ?

	Clé API	Jeton d’accès personnel (PAT)
Créé dans	Settings → Platform → Integrations	La CLI gaard
Portée	Un seul flow	Votre utilisateur (tous les tenants dont vous faites partie)
Idéal pour	Un service ou une intégration qui soumet des vidéos à un flow	La CLI et l’automatisation personnelle
Préfixe	Une valeur de clé générée	pat_
Géré par	N’importe quel administrateur	Le propriétaire du jeton

Les deux s’envoient de la même manière : comme jeton bearer dans l’en-tête Authorization :

terminal

curl -X POST https://vision.gaard.ai/api/classify \
  -H "Authorization: Bearer $GAARD_TOKEN" \
  -F "[email protected]"

Créer une clé API

Une clé API appartient à un flow et constitue l’identifiant utilisé par la plupart des intégrations pour soumettre des vidéos.

1. Ouvrez Settings → Platform → Integrations.

2. Sélectionnez l’intégration API Key.

3. Choisissez le Flow contre lequel la clé doit s’authentifier.

4. Donnez à la clé un Name qui identifie son usage, par exemple edge-uploader.

5. Copiez la valeur API Key générée et conservez-la en lieu sûr : traitez-la comme un mot de passe.

6. Sélectionnez Save. La clé apparaît dans la liste des intégrations avec son flow.

La clé authentifie les appels à l’API de classification pour son flow. Consultez Getting Started pour une présentation complète des requêtes.

Créer un jeton d’accès personnel

Les jetons d’accès personnels sont rattachés à l’utilisateur et se créent avec la CLI. Ils portent le préfixe pat_ et peuvent recevoir une date d’expiration.

terminal

# Créer un jeton
gaard token create --name ci-bot

# Créer un jeton qui expire dans 30 jours
gaard token create --name nightly-job --expires 720h

# Lister vos jetons
gaard token list

Attention

Le secret brut du jeton n’est affiché qu’une seule fois, au moment de sa création. Copiez-le immédiatement : Gaard n’en stocke qu’un hachage et ne peut plus l’afficher ensuite.

Pour la syntaxe complète des commandes, exécutez gaard token --help.

Rotation et révocation

Faites tourner les identifiants selon un calendrier régulier et dès qu’un identifiant a pu être exposé.

Clés API : les clés API ne tournent pas sur place. Pour en faire tourner une, créez une nouvelle clé API pour le même flow, faites basculer votre intégration vers la nouvelle clé, puis supprimez l’ancienne clé de la liste des intégrations via le menu de sa ligne.

Jetons d’accès personnels : définissez une expiration avec --expires lors de la création d’un jeton, et révoquez un jeton dès qu’il n’est plus nécessaire :

terminal

gaard token list
gaard token revoke <token-id>

Étapes suivantes

Flows Limiter clés et webhooks à un flow.

Choisir une méthode de livraison Polling, webhooks ou SFTP.