Menu da documentação

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.

CredencialFormatoOnde usarO que faz
Chave secretanvx_sk_live_... / nvx_sk_test_...Só no seu servidorAcesso completo, conforme os escopos
Chave públicanvx_pk_live_... / nvx_pk_test_...Site e app (front)Carrega o widget e envia eventos de rastreamento. Não lê dados.
Token de sessãonvx_st_...Site e app (front), gerado pelo seu servidorIdentifica um usuário logado no widget, por até 1 hora

Chaves secretas

Envie no cabeçalho Authorization:

bash
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.

EscopoPermite
agents:readListar e ver agentes
conversations:readLer conversas e mensagens
conversations:writeAbrir conversas, enviar mensagens, passar para humano, encerrar
contacts:read / contacts:writeLer / criar, atualizar e apagar contatos
knowledge:readLer o conhecimento e usar o /ask
knowledge:writeCriar, atualizar e apagar conhecimento e a tabela de serviços
learning:writeCorrigir respostas e aprovar sugestões de aprendizado
actions:writeCadastrar e alterar ações
webhooks:writeCadastrar e alterar webhooks
analytics:readLer métricas, funil, visitantes e linha do tempo de contatos
events:writeEnviar eventos de rastreamento pelo servidor
sessions:writeGerar tokens de sessão para o widget
forms:readLer 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.

bash
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"
    }
  }'
json
{
  "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 agenteReais, com o conhecimento atualReais
Envio por WhatsApp, SMS, emailNuncaConforme a configuração dos canais
Ações no seu sistemaChamadas, com o cabeçalho Nevox-Environment: testChamadas normalmente
WebhooksDisparados só para endpoints de testeDisparados para endpoints de produção
Franquia do planoNão contaConta
Limite20 requisições por minutoConforme o plano