DocTransform
AideAPIAuthentification

Authentification

Clés API Bearer, leurs portées, et les erreurs renvoyées par une clé invalide ou trop restreinte.

Un en-tête Bearer, une clé, aucune expiration.

L'API publique s'authentifie par une clé API Bearer — pas de cookie, pas de flux OAuth, et pas de mode de test séparé. Envoyez-la ainsi :

Authorization: Bearer $DOCTRANSFORM_API_KEY

Créer et gérer des clés

dt_live_…

Chaque clé commence par dt_live_. Elle n'expire jamais d'elle-même — vous la gardez jusqu'à ce que vous la révoquiez.

Jusqu'à 5 clés actives

Créez jusqu'à cinq clés par compte, depuis votre page de compte.

Une clé porte une ou plusieurs de trois portées : templates:read, runs:write et runs:read. Une nouvelle clé reçoit les trois.

Faire tourner une clé

Il n'y a pas de point de rotation sur place : créez d'abord la clé de remplacement, faites basculer votre script dessus, puis révoquez l'ancienne depuis la même carte de la page de compte.

Jamais dans un navigateur ni un dépôt

Ne mettez jamais une clé dans un navigateur ni un dépôt. Une clé API est un identifiant longue durée avec un accès complet au compte — conservez-la dans une variable d'environnement ou un gestionnaire de secrets, tout comme chaque exemple sur ces pages la lit :

curl "https://doctransform.xyz/api/v1/templates" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"

Quand l'authentification échoue

StatutCodeSignification
401API_KEY_MISSINGAucun en-tête Bearer n'a été envoyé.
401API_KEY_INVALIDLa clé est malformée, inconnue, révoquée, ou le compte est inactif.
403INSUFFICIENT_SCOPELa clé est valide mais ne porte pas la portée requise par cette opération.