Autenticação
Como a API pública autentica: chaves Bearer, seus escopos, e os erros de uma chave inválida ou limitada demais.
Um cabeçalho Bearer, uma chave, sem expiração.
A API pública é autenticada por uma chave de API Bearer — não há cookie, não há fluxo OAuth, e não há um modo de teste separado. Envie-a assim:
Authorization: Bearer $DOCTRANSFORM_API_KEYCriando e gerenciando chaves
dt_live_…
Toda chave começa com dt_live_. Ela nunca expira sozinha — você a mantém até revogá-la.
Até 5 chaves ativas
Crie até cinco chaves por conta, na sua página de conta.
Uma chave carrega um ou mais de três escopos: templates:read, runs:write e runs:read. Uma chave nova recebe os três.
Rotacionando uma chave
Não há um endpoint de rotação no local: crie primeiro a chave substituta, mude seu script para usá-la, depois revogue a antiga no mesmo cartão da página de conta.
Nunca em um navegador ou um repositório
Nunca coloque uma chave em um navegador ou um repositório. Uma chave de API é uma credencial de longa duração com acesso total à conta — guarde-a em uma variável de ambiente ou um gerenciador de segredos, assim como cada exemplo nessas páginas a lê:
curl "https://doctransform.xyz/api/v1/templates" \
-H "Authorization: Bearer $DOCTRANSFORM_API_KEY"Quando a autenticação falha
| Status | Código | Significado |
|---|---|---|
| 401 | API_KEY_MISSING | Nenhum cabeçalho Bearer foi enviado. |
| 401 | API_KEY_INVALID | A chave está malformada, é desconhecida, foi revogada, ou a conta está inativa. |
| 403 | INSUFFICIENT_SCOPE | A chave é válida mas não carrega o escopo que esta operação exige. |