Aller au contenu principal

Clés API

Les clés API offrent aux scripts et aux intégrations un accès programmatique à longue durée de vie à l'API REST sans session de navigateur.

Émettre une clé​

Créez une clé de deux façons :

  • Dans l'application, depuis Paramètres → Clés API.
  • Via l'API, avec POST /api/v1/keys et un name :
curl -X POST https://<your-host>/api/v1/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ci-export-bot" }'

La réponse contient la clé complète, qui commence par ef_live_.

attention

La valeur de la clé (ef_live_...) n'est affichée qu'une seule fois. EntityFlow n'en stocke qu'un hachage — elle ne pourra plus jamais être récupérée. Copiez-la immédiatement et conservez-la en lieu sûr.

Utiliser une clé​

Envoyez-la comme jeton porteur (bearer token) sur n'importe quelle requête REST :

curl https://<your-host>/api/v1/diagrams \
  -H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"

Lister et révoquer​

Vous pouvez lister et révoquer des clés à tout moment, depuis Paramètres → Clés API ou via les points de terminaison /api/v1/keys. La révocation d'une clé prend effet immédiatement.

Autorisations​

L'émission et la révocation de clés nécessitent l'autorisation account:manage. Une clé hérite des autorisations à portée de locataire (tenant) du compte qui la détient.