API
O módulo de API do TeResponde: para que serve, quem tem acesso e onde obter o token.
O módulo API existe no menu da plataforma e a API Externa consta nos planos Empresa e Premium. Mas a especificação técnica — URL base, forma de autenticação, endpoints, formato de payload e códigos de erro — não foi verificada.
Documentar endpoint sem confirmar é pior que não documentar: você escreveria código contra uma rota que talvez não exista. Por isso esta página explica o que a API é e como obter a especificação real, sem inventar nenhuma rota.
O que é#
A API permite que os seus sistemas conversem com o TeResponde sem ninguém operando a tela — tipicamente para disparar mensagem a partir de outro software, sincronizar contatos ou reagir a um atendimento em um sistema próprio.
Onde fica: Administração › API
Em quais planos está incluída#
| Plano | API Externa |
|---|---|
| Básico | Não incluída |
| Empresa | Incluída |
| Premium | Incluída |
Se a sua conta é do plano Básico, o módulo pode não estar disponível. Os planos ficam em Planos.
Token de acesso#
O acesso programático depende de uma credencial gerada na plataforma. Abra Administração › API para obtê-la.
Quem tem o token age em nome da sua conta: pode ler contatos e disparar mensagens pelos seus números.
- nunca coloque o token em código versionado no Git;
- nunca mande por WhatsApp, e-mail ou captura de tela;
- guarde em variável de ambiente ou em um gerenciador de segredos;
- se ele vazar, gere um novo imediatamente.
Em vez de escrever a credencial no código, leia do ambiente. O trecho abaixo é ilustrativo e não representa nenhum endpoint real do TeResponde:
# Certo: o token vem do ambiente, não do arquivo
export TERESPONDE_TOKEN="seu-token-aqui"
# No código, leia a variável:
# Node.js -> process.env.TERESPONDE_TOKEN
# PHP -> getenv('TERESPONDE_TOKEN')
# Python -> os.environ['TERESPONDE_TOKEN']
# Errado: token escrito no código e enviado ao repositório
# const token = "abc123..."; <-- nunca faça issoComo obter a especificação real#
-
Abra o módulo API na plataforma#
Administração › API. Boa parte dos sistemas exibe ali a documentação das rotas, exemplos e o token.
-
Peça a documentação ao suporte#
Pelo WhatsApp (21) 96622-8931 ou por contato@teresponde.com.br. Peça: URL base, método de autenticação, endpoints disponíveis, exemplo de requisição e resposta, limites de uso.
-
Teste em ambiente controlado#
Antes de integrar em produção, dispare para um número seu. Evite testar volume pelo número do atendimento — veja boas práticas.
Webhooks e eventos#
Não foi confirmado se o TeResponde envia webhooks de eventos — mensagem recebida, ticket criado, atendimento finalizado — nem onde uma URL de retorno seria configurada.
Limites de uso#
Eventuais limites de requisições por minuto ou por dia não foram verificados. Pergunte ao suporte antes de construir uma integração que dependa de alto volume.
O uso de integrações e APIs está tratado nos Termos de Uso, na seção “Integrações e APIs”.