API Keys

Visão Geral

API Keys são credenciais que permitem acesso programático à API da Nuria. Use-as para integrar sistemas externos.

🔗 Acesse: Integrações

Passo a Passo

1. Criar API Key

- Acesse Configurações > Integrações > API Keys

- Clique em Nova API Key

- Defina:

- Nome: Identificador (ex: "Integração ERP")

- Permissões: Quais recursos a key pode acessar

- Expiração: Data de validade (opcional)

2. Copiar a key

- Após criar, copie a API Key imediatamente

- A key só é exibida uma vez por segurança

- Armazene em local seguro

3. Usar na API

- Inclua a key no header das requisições:

- Header: Authorization: Bearer SUA_API_KEY

- Todas as chamadas devem incluir o header x-nuria-tenant-id

4. Gerenciar keys

- Veja a lista de keys ativas

- Desative keys que não são mais usadas

- Regenere keys comprometidas

Regras de Negócio

- Cada key tem permissões específicas

- Keys expiradas param de funcionar automaticamente

- Rate limiting se aplica: verifique os limites do seu plano

- Ações feitas via API são registradas nos logs

Dicas e Boas Práticas

- Crie keys separadas para cada integração

- Use permissões mínimas necessárias

- Não compartilhe keys em código público

- Rotacione keys periodicamente por segurança

- Desative keys de integrações desativadas