Autenticação
API Key da empresa, org key e JWT do painel.
A NFER separa conta (billing / multi-CNPJ) e empresa (CNPJ emissor). Emissão usa a API Key da empresa (1 key por CNPJ). Gestão da conta usa org key nfer_org_… ou JWT.
Como obter
- Cadastro no painel (/register),
POST /v1/accountsouPOST /v1/companies - Copie a company
apiKey(eorgApiKeyse retornada) — não serão exibidas de novo - Parceiros (ex. LinkaERP): abram o login com ID pré-preenchido; persistam N pares companyId+apiKey por cliente
Como usar
| Forma | Uso |
|---|---|
X-API-Key | Company key: emissão. Org key nfer_org_…: gestão da conta |
?api_key= | Alternativa (abrir PDF/XML no browser) |
Authorization: Bearer | JWT do POST /v1/auth/login (painel; switch-company se multi-CNPJ) |
Rotas públicas: GET /health, POST /v1/companies, POST /v1/accounts, POST /v1/auth/login.
Request headerhttp
X-API-Key: a0eebc99.seu-segredo-aqui # gestão da conta X-API-Key: nfer_org_abcd1234.seu-segredo # ou (painel) Authorization: Bearer eyJhbGciOi...
Segurança
Nunca exponha a API Key em frontend, repositórios públicos ou logs. Use variáveis de ambiente. Se comprometida, regenere no painel / suporte.
Formato
<8-chars-do-uuid>.<segredo> — ex.: a0eebc99.super-secret-key-123Erros de auth
| Status | Motivo |
|---|---|
| 401 | Header ausente, inválido ou JWT expirado |
| 403 | Empresa inativa ou sem permissão no recurso |
| 429 | Rate limit — respeite Retry-After / mensagem |
GET
/health