Skip to main content

Autenticação

Todas as chamadas à API do Brainchat (exceto endpoints públicos) exigem autenticação via header X-Client-Token.

Gerar Token

1

Acesse o Dashboard

Faça login em brainchat.app.
2

Vá em Instâncias

Acesse Instâncias → Gerador de Embedding.
3

Copie o Token

O X-Client-Token é exibido na tela. Copie e use nas chamadas à API.

Como usar

Inclua o token no header de todas as requisições:

Headers obrigatórios

Chave de embed + token

Nas rotas de atendimento (/conversations-api/...) a identificação do canal é feita pela chave de embed (embedKey, no corpo da requisição), e não pelo identificador interno do canal. As duas precisam pertencer ao mesmo canal; se forem de canais diferentes, a chamada é recusada com 403.
Durante a transição, chamadas com apenas uma das credenciais continuam funcionando, mas a resposta traz um campo deprecation avisando que o par passará a ser obrigatório.

Segurança

  • Nunca exponha o token no frontend ou código-fonte público
  • Armazene o token em variáveis de ambiente no servidor
  • Gere um novo token se suspeitar de vazamento
  • O token está vinculado à sua instância

Base URL

Todos os endpoints da API usam esta base URL.