- Começando
- Autenticação
Começando
Autenticação
As duas credenciais da API e quando usar cada uma.
A API usa credenciais diferentes para a conta Enterprise e para cada empresa emitente (organization).
| Header | Quem usa | Rotas |
|---|---|---|
x-enterprise-key: <chave> | Conta Enterprise | /enterprise/* e /bff/enterprise-group/* |
x-api-key: <rawKey> | Organization | NF-e, eventos, cadastros e certificado |
Chave Enterprise
A x-enterprise-key identifica a sua conta Enterprise e tem o escopo enterprise:manage. Use-a nas rotas de gestão de organizations, API Keys e links de configuração fiscal.
curl https://api.treeunfe.com.br/api/v1/enterprise/organizations \
-H "x-enterprise-key: SUA_ENTERPRISE_KEY" ...
A chave Enterprise dá acesso a todas as empresas emitentes da conta. Use-a só no seu backend, nunca em apps ou no navegador.
API Key da organization
A x-api-key é gerada para uma organization e só acessa os dados dela. É a credencial das rotas operacionais (emissão, eventos, cadastros). Veja API Keys para escopos, ambientes e validade.
curl -X POST https://api.treeunfe.com.br/api/v1/nfe \
-H "x-api-key: RAW_KEY_DA_ORGANIZATION" ...
Se a organization estiver inativa, as chaves dela recebem 403 Organization is inactive.