Autenticação
A API Nexus utiliza API Key para autenticar todas as requisições de integração.
API Key
Método padrão para todas as integrações. Simples, seguro e direto.
Integrações ExternasAutenticação com API Key
A API Key é a forma mais simples de autenticar requisições à API Nexus. Ela deve ser enviada no header X-API-KEY de todas as requisições.
Como Usar
curl -X GET "https://app.nexuscomunicacao.com.br/api/v1/integration/balance" \ -H "X-API-KEY: nxc_live_abc123..."
Formato da API Key
Todas as API Keys seguem o formato:
- Produção:
nxc_live_[40 caracteres aleatórios] - Teste:
nxc_test_[40 caracteres aleatórios]
Segurança: Nunca compartilhe ou exponha sua API Key em código front-end, repositórios públicos ou logs. Armazene sempre em variáveis de ambiente.
Gerar API Key
Para gerar uma API Key para suas integrações, utilize o painel web da Nexus:
- Acesse Configurações → API Keys no painel
- Clique em "Gerar Nova API Key"
- Escolha o ambiente: Produção (
nxc_live_) ou Teste (nxc_test_) - Copie a chave gerada e armazene em local seguro
Importante: A API Key só será exibida uma vez no momento da criação. Se perdê-la, será necessário gerar uma nova chave.
Gerenciamento: Você pode revogar API Keys antigas ou inativas a qualquer momento pelo painel para maior segurança.
Melhores Práticas de Segurança
1. Armazenamento de Credenciais
# .env NEXUS_API_KEY=nxc_live_abc123...
2. Rotação de Credenciais
- Rotacione API Keys periodicamente (recomendado: a cada 90 dias)
- Revogue imediatamente chaves comprometidas
- Mantenha registro de quando e onde cada chave é usada
3. Rate Limiting por Tier
A API implementa rate limiting baseado no tier da sua conta:
| Tier | Limite | Descrição |
|---|---|---|
| Free | 10 req/min | Ideal para testes e POCs |
| Basic | 30 req/min | Pequenos volumes de envio |
| Pro | 100 req/min | Médio volume, múltiplas integrações |
| Enterprise | 500 req/min | Alto volume, SLA personalizado |
Headers de resposta:
X-RateLimit-Limit- Limite total do seu tierX-RateLimit-Remaining- Requisições restantes na janela atualX-RateLimit-Reset- Timestamp de reset do contador
Atenção: Ao exceder o limite, receberá erro
429 Too Many Requests. Aguarde o reset da janela ou considere upgrade do tier.
4. IP Whitelist (Opcional)
Configure IPs permitidos no painel administrativo para maior segurança:
- Acesse Configurações → Segurança
- Adicione IPs autorizados
- Requisições de outros IPs serão bloqueadas
Erros de Autenticação
| Código | Mensagem | Solução |
|---|---|---|
| 401 | MISSING_API_KEY | Inclua o header X-API-KEY ou Authorization |
| 401 | INVALID_API_KEY | Verifique se a API Key está correta e ativa |
| 401 | TOKEN_EXPIRED | Faça login novamente para obter novo token |
| 403 | FORBIDDEN | Usuário não tem permissão para esta ação |