Treeunfe API home pagelight logo
  1. API Keys
  2. Criar API Key
POST
/enterprise/organizations/{organizationId}/api-keys
curl --request POST \
     --url https://api.treeunfe.com.br/api/v1/enterprise/organizations/{organizationId}/api-keys \
     --header 'x-api-key: <api-key>' \
     --header 'x-enterprise-key: <x_enterprise_key>' \
     --header 'Content-Type: application/json' \
     --data '{
  "name": "<string>",
  "scopes": "<string>",
  "tpAmb": "<string>",
  "expirationPreset": "<string>"
}'

Gera uma nova API Key para uma organization existente. Pode ser usada para organizations criadas sem chave ou para gerar chaves adicionais (por exemplo, uma de homologação e outra de produção).

O rawKey só aparece nesta resposta.

​
Autenticação

Envie o header x-enterprise-key.

x-enterprise-key
string

Chave da conta Enterprise (escopo enterprise:manage).

​
Parâmetros de rota

organizationId
required
string

ID (UUID) da organization.

​
Body

application/json

name
required
string

Nome de identificação da chave.

scopes
required
string

Escopos separados por vírgula. Valores: nfe:emit, nfe:read, nfse:emit, nfse:read.

tpAmb
required
string

Ambiente SEFAZ em que a chave pode emitir. Valores: HOMOLOGACAO, PRODUCAO.

expirationPreset
required
string

Validade da chave a partir da criação.

​
Respostas

StatusDescrição
201Chave criada.
400Body inválido (campo obrigatório ausente, formato incorreto ou campo não permitido).
401Credencial ausente, inválida ou expirada.
404Recurso não encontrado.
curl -X POST "https://api.treeunfe.com.br/api/v1/enterprise/organizations/7a6b2d8e-4bc3-4a25-a298-adb3ba63f9de/api-keys" \
  -H "x-enterprise-key: SUA_ENTERPRISE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "integracao-nfe-homolog",
    "scopes": "nfe:emit,nfe:read",
    "tpAmb": "HOMOLOGACAO",
    "expirationPreset": "1y"
  }'

{
  "keyId": "string",
  "rawKey": "string"
}