Skip to main content
Toda requisição leva o header:
A credencial pode ser: As duas agem como a mesma Conta, sobre todos os Prestadores vinculados a ela. Não há permissões por Prestador: quem tem uma Chave da Conta acessa todos os Prestadores da Conta.

Chaves de API

  • O valor da chave aparece uma única vez, na criação. O NotasX guarda só um hash; não há como recuperá-lo.
  • O prefixo (os 10 primeiros caracteres) aparece na listagem, para você saber qual chave é qual.
  • Revogue com DELETE /v1/chaves-api/{id}: o efeito é imediato e não tem volta.
  • Crie uma chave por sistema. Assim você revoga uma sem derrubar as outras.
Uma Chave de API pode criar outras Chaves. Trate-a como uma senha: nunca a coloque em código de front-end, em repositório ou em log.

Respostas de autenticação

Credencial ausente, inválida, revogada ou expirada recebe 401:
Recursos de Prestadores que não são da sua Conta respondem 404, como se não existissem.