Configurar API/Webhook
Gere e copie o **Token da API** e informe a **URL do Webhook** para integrar com plataformas externas.
Para que serve
Use o Webhook para enviar automaticamente os dados das conversas para outro sistema.
Use o Token da API para acessar e testar as APIs do sistema.
Também há links de ajuda como API e Webhook (vídeo) e Wiki (Como integrar).
Resumo rápido
- Abra Documentacao da API para ver e testar as APIs no navegador.
- Em Token da API, clique em Gerar Token (ou Regerar Token).
- Clique em Copiar para colocar o token na área de transferência.
- Em Webhook, preencha uma URL começando com http:// ou https://.
- Clique em Salvar no bloco de Webhook.
Resultado esperado: O token fica disponível em Token da API e a URL fica salva em Webhook, com mensagem de sucesso como "Dados do usuário salvo com sucesso!" (ao salvar o webhook) ou "Token gerado com sucesso" (ao gerar o token).
Campos principais
Token da API
edit_notetexto (somente leitura)Descrição: Use este valor para autenticar chamadas de API.
Para criar um token, clique em Gerar Token.
Para trocar por outro token, clique em Regerar Token.
Para copiar, clique em Copiar.
Regras/validações: Não há edição manual (campo readonly).
Ao copiar, pode aparecer:
- "Token copiado para a área de transferência!"
- "Falha ao copiar o token."
Exemplos: - Exemplo de uso: clicar em Gerar Token e depois em Copiar.
- Exemplo de uso: clicar em Regerar Token quando precisar substituir o token atual.
Webhook
edit_notetexto (URL)Descrição: Cole a URL do sistema que vai receber os dados.
Depois, clique em Salvar para gravar a URL.
Regras/validações: Precisa ser uma URL válida com http:// ou https://.
Mensagens que podem aparecer:
- "Favor inserir a Url do webhook!" (quando fica vazio)
- "Favor inserir uma Url válida!" (quando não parece uma URL correta)
Exemplos: - https://meusite.com/webhook
- http://exemplo.com:8080/webhook/receber
Como configurar
Abrir a documentação
Clique em Documentacao da API para abrir a documentação interativa em outra aba.
Gerar o Token da API
Em Token da API, clique em Gerar Token.
Se já existir um token e for preciso trocar, clique em Regerar Token.
Copiar o token
Clique em Copiar.
Confirme pela mensagem "Token copiado para a área de transferência!".
Preencher o Webhook
Em Webhook, preencha a URL completa.
Use sempre http:// ou https:// no começo.
Salvar o Webhook
Clique em Salvar.
Se tudo estiver certo, aparece "Dados do usuário salvo com sucesso!".
Termos que aparecem e o que significam
- Webhook: É um jeito de enviar dados automaticamente para outro sistema via HTTP, quando acontece um evento.
Na prática: o sistema envia informações assim que algo relevante acontece, sem precisar ficar “consultando” toda hora. - Token da API: É uma chave usada para acessar a API.
Na prática: copiar e usar este token no sistema externo para permitir o acesso. - Documentacao da API: É um link para visualizar e testar as APIs do sistema de forma interativa no navegador.
Regras importantes
- Preencha o campo Webhook antes de salvar; se ficar vazio aparece "Favor inserir a Url do webhook!".
- Use uma URL válida no Webhook; se não for válida aparece "Favor inserir uma Url válida!".
- O campo Token da API é somente leitura; use Gerar Token ou Regerar Token para criar/atualizar.
- Use Copiar para evitar erros ao transferir o token.
Problemas comuns e como resolver
Causa provável: O campo Webhook está vazio.
Como corrigir: Preencha o campo Webhook com uma URL completa (com http:// ou https://).
Depois clique em Salvar novamente.
Como confirmar: Verifique se não aparece mais a mensagem de erro e se aparece "Dados do usuário salvo com sucesso!".
Causa provável: A URL do Webhook não está em um formato aceito (por exemplo, sem http:// ou https://).
Como corrigir: Revise o começo da URL e inclua http:// ou https://.
Exemplo: https://...
Como confirmar: Clique em Salvar e confirme que o erro não volta.
Causa provável: A cópia para a área de transferência não foi concluída.
Como corrigir: Clique em Copiar novamente.
Se continuar, tente copiar logo após gerar/regerar o token.
Como confirmar: Confirme pela mensagem "Token copiado para a área de transferência!".
Guia rápido do que usar agora
- Ajuda (vídeo e Wiki): Use os links API e Webhook (Como funciona) e Wiki (Como integrar) quando precisar de orientação.
- API: Use Token da API com os botões Gerar Token, Regerar Token e Copiar.
Use Documentacao da API para abrir a documentação em outra aba. - Webhook: Preencha o campo Webhook com a URL do sistema que vai receber os dados.
Finalize clicando em Salvar.