Autenticação

A API Notaas usa API Keys para autenticar requisições. Todas as chamadas autenticadas devem incluir o header x-api-key com uma chave válida associada ao seu projeto.

Obtendo sua API Key

  1. Acesse o Dashboard → API Keys
  2. Clique em Nova Key
  3. Selecione o projeto e defina o rate limit desejado
  4. Copie a chave gerada — ela não será exibida novamente

Usando a API Key

Inclua a chave no header x-api-key em todas as requisições:

curl -X POST https://platform.notaas.com.br/api/v1/emitir \
  -H "Content-Type: application/json" \
  -H "x-api-key: ntaas_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -d '{ ... }'

Tipos de API Key

A Notaas utiliza dois tipos de chave, ambas enviadas no mesmo header x-api-key. A API identifica o tipo pelo prefixo.

TipoPrefixoRotasUso
Project Keyntaas_/api/v1/emitir, /cancelar, /invoices, /webhooksEmissão e consulta de notas
Org Tokenntaas_org_/api/v1/org/*Gestão de projetos, keys e settings

ℹ️ Org Tokens são criados no dashboard em Settings → API Tokens. Possuem escopos granulares (projects:write, api_keys:manage, etc.) e rate limit de 120 req/min. Ver documentação completa →

Erros de Autenticação

StatusMotivo
401Header x-api-key ausente ou inválido
403Chave revogada ou sem permissão para o projeto
429Rate limit excedido — verifique header Retry-After

⚠️ Segurança

Nunca exponha sua API Key em código frontend, repositórios públicos ou logs. Use variáveis de ambiente. Se uma chave for comprometida, revogue-a imediatamente no dashboard.