Autenticação
Uma chave para todos os produtos da conta. Criada no portal, enviada no cabeçalho, revogável a qualquer momento.
Criar
No portal, em Conta › Chaves de API. Dê um nome que diga onde ela vai ser usada, como ERP produção ou script de importação. É esse nome que aparece na lista quando você precisar decidir qual revogar.
Usar
curl https://comexdoc.com.br/v1/ebl/documents \ -H "Authorization: Bearer cxd_live_..."
Toda chave começa com cxd_live_. Isso ajuda a reconhecê-la quando ela aparece num log ou numa variável de ambiente.
A chave é da empresa, não de uma pessoa
Não há usuário atrás de uma chave. Assim a integração continua funcionando quando alguém sai da empresa.
Mais de uma chave pode ficar ativa ao mesmo tempo. É assim que se troca sem parar nada: cria a nova, migra os sistemas, revoga a antiga.
Revogar
O efeito é imediato: a próxima requisição com ela recebe 401. O histórico das leituras feitas com aquela chave continua disponível.
O que uma chave alcança
As rotas dos produtos, que são as documentadas aqui. As telas de administração da conta, como gestão de usuários e configuração de entrega, ficam só no portal.
| Situação | Resposta |
|---|---|
| Chave ausente, inválida ou revogada | 401 |
| Chave válida numa rota que só existe no portal | 403 |
| Recurso de outra conta | 404, sem confirmar se ele existe |