Autenticação
Toda chamada à API de integração leva a chave no header x-api-key:
curl https://api.dynadok.com/v1/api/catalog/documents \
--header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE'
A chave não vai no header Authorization nem como Bearer. A única exceção é
o token temporário de uma chave escopada,
que é opcional.
Formato da chave
A chave tem duas partes separadas por ponto: <uuid>.<segredo>. As duas viajam
juntas, sempre — o uuid identifica a chave e o segredo a autentica.
Como obter
A chave é gerada no painel da Dynadok, em Chaves de API, por um usuário da sua empresa com permissão de administrador. Ao gerar, escolha o tipo de acesso:
| tipo | o que a chave pode fazer |
|---|---|
| Escopada (recomendado) | só as operações e os projetos marcados na geração — ver Chaves escopadas |
| Legada | todas as rotas da API de integração, em todos os projetos da empresa |
Chaves geradas antes da existência desse tipo de acesso continuam funcionando como legadas. Uma chave legada pode ser restringida depois, no mesmo painel, sem trocar o segredo.
O servidor guarda apenas o hash do segredo. Se a chave for perdida, não há como recuperá-la: só gerar outra e revogar a anterior.
Escopo
Cada chave pertence a uma empresa, e toda requisição feita com ela age no escopo dessa empresa. Não há header para trocar de empresa numa chamada por chave de API: para operar em outra empresa, use uma chave dela.
Chave revogada, expirada ou inválida responde 401. Chave escopada sem a permissão da rota, ou fora do projeto do recurso, responde 403.