Autenticação
Autenticação via API Key
A API NFS-e Nacional suporta autenticação por API Key de Workspace, indicada para integrações server-to-server (ERPs, sistemas de automação, etc.) sem necessidade de login interativo.
Formato da chave
As chaves são geradas com o prefixo ntk_ seguido de 64 caracteres hexadecimais:
Code
Como autenticar
Envie a chave no header Authorization no lugar do Bearer JWT:
Code
Selecionando a empresa
Um workspace pode ter múltiplas empresas. Para selecionar qual empresa usar na requisição, passe o header empresa-id:
Code
Se
empresa-idfor omitido, a empresa padrão do workspace será usada automaticamente.
Exemplo completo
Listar tomadores
Code
Erros comuns
| Status | Mensagem | Causa |
|---|---|---|
401 | API Key inválida ou revogada | Chave incorreta ou revogada |
403 | Empresa não pertence ao workspace desta API Key | empresa-id não pertence ao workspace da chave |
403 | Esta operação requer autenticação via token JWT | Tentativa de gerenciar chaves usando uma API Key |
404 | Nenhuma empresa vinculada a este workspace | Workspace sem empresas cadastradas |
Last modified on