Autenticação
Chaves secretas, chaves públicas, escopos e tokens de sessão para o front.
A API usa três tipos de credencial. Cada um tem um lugar certo.
| Credencial | Formato | Onde usar | O que faz |
|---|---|---|---|
| Chave secreta | nvx_sk_live_... / nvx_sk_test_... | Só no seu servidor | Acesso completo, conforme os escopos |
| Chave pública | nvx_pk_live_... / nvx_pk_test_... | Site e app (front) | Carrega o widget e envia eventos de rastreamento. Não lê dados. |
| Token de sessão | nvx_st_... | Site e app (front), gerado pelo seu servidor | Identifica um usuário logado no widget, por até 1 hora |
Chaves secretas
Envie no cabeçalho Authorization:
curl https://api.nevox.ai/v1/agents \
-H "Authorization: Bearer nvx_sk_live_..."Gerenciamento
- Só o dono da conta gera chaves, em Painel → Desenvolvedores → Chaves de API.
- A chave aparece uma única vez. A Nevox guarda só uma versão criptografada (hash). Se perder, gere outra.
- Você pode ter várias chaves (uma por sistema) e revogar qualquer uma na hora. A revogação vale em até 1 minuto.
- O painel mostra o último uso de cada chave e o registro das chamadas, com os erros.
- Se uma chave aparecer num repositório público, revogue e gere outra imediatamente.
Escopos
Dê a cada chave só o que ela precisa. Os escopos dos recursos que ainda vão chegar podem ser marcados desde já: passam a valer quando o recurso chegar.
| Escopo | Permite |
|---|---|
agents:read | Listar e ver agentes |
conversations:read | Ler conversas e mensagens |
conversations:write | Abrir conversas, enviar mensagens, passar para humano, encerrar |
contacts:read / contacts:write | Ler / criar, atualizar e apagar contatos |
knowledge:read | Ler o conhecimento e usar o /ask |
knowledge:write | Criar, atualizar e apagar conhecimento e a tabela de serviços |
learning:write | Corrigir respostas e aprovar sugestões de aprendizado |
actions:write | Cadastrar e alterar ações |
webhooks:write | Cadastrar e alterar webhooks |
analytics:read | Ler métricas, funil, visitantes e linha do tempo de contatos |
events:write | Enviar eventos de rastreamento pelo servidor |
sessions:write | Gerar tokens de sessão para o widget |
forms:read | Ler os formulários enviados nos sites |
Uma chamada sem o escopo necessário recebe 403 com o código insufficient_scope.
Chaves públicas
A chave pública identifica sua conta no front. Ela só pode:
- carregar o widget do agente;
- enviar eventos de rastreamento de visitantes (
/v1/collect).
Ela não lê conversas, contatos nem métricas. Mesmo assim, você define em Painel → Desenvolvedores → Widget no seu app quais domínios podem usá-la. Requisições de outros domínios são recusadas com 403 origin_not_allowed. Há uma chave pública por ambiente; gerar outra desativa a anterior na hora.
Token de sessão
Quando o usuário já está logado no seu sistema, o seu servidor gera um token de sessão e entrega ao front. Assim o widget sabe quem é a pessoa sem expor a chave secreta.
curl https://api.nevox.ai/v1/widget/sessions \
-H "Authorization: Bearer $NEVOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agent_id": "agt_8f2k1x",
"contact": {
"external_id": "paciente_1042",
"name": "Maria Souza",
"email": "maria@exemplo.com",
"language": "pt-BR"
}
}'{
"token": "nvx_st_9c1e...",
"expires_at": "2026-11-03T15:30:00Z",
"contact_id": "ctc_4hq81"
}O token vale por 1 hora e serve só para aquele contato e aquele agente. Gere um novo a cada login ou quando expirar. Veja como usar no widget.
Ambientes
Teste (_test_) | Produção (_live_) | |
|---|---|---|
| Respostas do agente | Reais, com o conhecimento atual | Reais |
| Envio por WhatsApp, SMS, email | Nunca | Conforme a configuração dos canais |
| Ações no seu sistema | Chamadas, com o cabeçalho Nevox-Environment: test | Chamadas normalmente |
| Webhooks | Disparados só para endpoints de teste | Disparados para endpoints de produção |
| Franquia do plano | Não conta | Conta |
| Limite | 20 requisições por minuto | Conforme o plano |