Autenticação
A API usa chaves de API por empresa. Toda requisição autenticada envia a
chave no header Authorization, no esquema Bearer:
Authorization: Bearer ck_live_xxxxxxxxxxxxxxxxxxxxxxxxGerando uma chave
- No painel, acesse Chaves de API no menu lateral.
- Clique em Nova chave, dê um nome e selecione os escopos.
- Copie o segredo na hora — ele é exibido uma única vez. Guardamos apenas um hash (Argon2id + pepper, o mesmo esquema das senhas); não é possível recuperar a chave depois.
Formato da chave
ck_<ambiente>_<lookupId>_<secret>ambiente:liveoutest(rótulo lógico).lookupId: identificador público que localiza a chave.secret: a parte secreta, verificada via hash.
Escopos
Restringem o que a chave pode fazer. Uma chave sem escopos tem acesso total dentro da empresa.
| Escopo | Permite |
|---|---|
documents:read | Ler documentos fiscais |
documents:write | Emitir / alterar documentos |
companies:read | Ler dados da empresa |
Boas práticas
- Use uma chave por integração — facilita revogar sem afetar as demais.
- Conceda somente os escopos necessários.
- Revogue chaves comprometidas imediatamente (a revogação é instantânea).
- Nunca exponha a chave no front-end; mantenha-a apenas no servidor.
Erros de autenticação
| Status | code | Significado |
|---|---|---|
401 | missing_api_key | Header Authorization ausente |
401 | invalid_api_key | Chave inválida, revogada ou expirada |
403 | insufficient_scope | A chave não tem o escopo exigido |
Last updated on