Treeunfe API home pagelight logo
  1. Conceitos
  2. API Keys

Cada organization pode ter várias API Keys — por exemplo, uma para homologação e outra para produção.

​
Como gerar

Há dois jeitos:

  • Junto com a organization: em Criar organization, envie generateApiKey: true e apiKeyOptions. A chave volta em apiKey.
  • Depois: use POST /enterprise/organizations/{organizationId}/api-keys. A chave volta na raiz da resposta.

Nos dois casos a resposta traz:

CampoDescrição
keyIdID da chave.
rawKeyO valor para o header x-api-key.

O rawKey é exibido uma única vez. Se ele for perdido, gere uma nova chave.

​
Opções da chave

{
  "name": "integracao-nfe-homolog",
  "scopes": "nfe:emit,nfe:read",
  "tpAmb": "HOMOLOGACAO",
  "expirationPreset": "1y"
}
CampoDescrição
nameNome para identificar a chave.
scopesPermissões, separadas por vírgula. Veja abaixo.
tpAmbHOMOLOGACAO ou PRODUCAO. A chave só emite no ambiente escolhido.
expirationPresetValidade a partir da criação. Ex.: 1y (um ano).

​
Escopos

EscopoPermite
nfe:emitEmitir NF-e e registrar eventos
nfe:readConsultar NF-e e eventos
nfse:emitEmitir NFS-e
nfse:readConsultar NFS-e

Dê a cada chave só os escopos de que a integração precisa.

​
Ambiente

O ambiente da nota vem da API Key: uma chave de HOMOLOGACAO emite em homologação e uma de PRODUCAO, em produção. Não informe o ambiente no payload.

Integre e teste com uma chave de HOMOLOGACAO. Gere a chave de PRODUCAO só quando for para o ar.