DocTransform
AiutoAPIAutenticazione

Autenticazione

Come si autentica l'API pubblica: chiavi Bearer, i loro scope, e gli errori restituiti da una chiave non valida o troppo limitata.

Un'intestazione Bearer, una chiave, nessuna scadenza.

L'API pubblica si autentica con una chiave API Bearer — non c'è nessun cookie, nessun flusso OAuth, e nessuna modalità di test separata. Inviala così:

Authorization: Bearer $DOCTRANSFORM_API_KEY

Creare e gestire le chiavi

dt_live_…

Ogni chiave inizia con dt_live_. Non scade mai da sola — la mantieni finché non la revochi.

Fino a 5 chiavi attive

Crea fino a cinque chiavi per account, dalla tua pagina account.

Una chiave porta uno o più di tre scope: templates:read, runs:write e runs:read. Una nuova chiave riceve tutti e tre.

Ruotare una chiave

Non c'è un endpoint di rotazione sul posto: crea prima la chiave sostitutiva, sposta il tuo script su di essa, poi revoca la vecchia dalla stessa scheda della pagina account.

Mai in un browser o in un repository

Non mettere mai una chiave in un browser o in un repository. Una chiave API è una credenziale a lunga durata con accesso completo all'account — conservala in una variabile d'ambiente o in un gestore di segreti, proprio come ogni esempio su queste pagine la legge:

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

Quando l'autenticazione fallisce

StatoCodiceSignificato
401API_KEY_MISSINGNon è stata inviata l'intestazione Bearer.
401API_KEY_INVALIDLa chiave è malformata, sconosciuta, revocata, o l'account è inattivo.
403INSUFFICIENT_SCOPELa chiave è valida ma non porta lo scope richiesto da questa operazione.