Skip to main content

​
Autenticacao

Todas as requisicoes a API publica do TroiaChat exigem uma API Key valida enviada no header X-API-Key.

​
Como funciona

X-API-Key: sua-chave-aqui
A API Key identifica automaticamente:
  • App — a aplicacao (whitelabel) que voce esta acessando
  • Empresa — a empresa vinculada a chave
  • Permissoes — o que a chave pode fazer
Nao e necessario enviar appId ou companyId no body das requisicoes. O sistema resolve o contexto multi-tenant automaticamente a partir da API Key.

​
Gerando uma API Key

1

Acesse o painel

No TroiaChat, va em Configuracoes > API Keys.
2

Crie uma nova chave

Clique em Criar nova chave, de um nome descritivo (ex: “Integracao Site”, “Webhook Meta”).
3

Copie a chave

A chave sera exibida uma unica vez. Copie e armazene em local seguro.
Se voce perder a chave, sera necessario criar uma nova. Chaves nao podem ser recuperadas apos a criacao.

​
Boas praticas de seguranca

PraticaDescricao
Armazene em variavel de ambienteNunca coloque a chave diretamente no codigo-fonte.
Use chaves distintas por integracaoCrie uma chave para cada sistema integrado. Facilita auditoria e revogacao.
Rotacione periodicamenteCrie novas chaves e desative as antigas regularmente.
Monitore o usoAcompanhe o campo “Ultimo uso” no painel para detectar uso inesperado.

​
Exemplo de uso

curl -X POST https://api.troiachat.com/api/leads/public/STEP_ID \
  -H "Content-Type: application/json" \
  -H "X-API-Key: tk_live_abc123def456" \
  -d '{"name": "Lead Teste", "phones": ["5511999999999"]}'

​
Erros de autenticacao

StatusErroCausa
401API Key requiredHeader X-API-Key ausente na requisicao.
401Invalid or inactive API KeyChave inexistente ou desativada.
401API Key has expiredChave com data de expiracao ultrapassada.
403API Key does not belong to this applicationChave pertence a outra aplicacao.