API REST
As instruções abaixo são apenas para computadores de mesa e laptops.
A API REST do tawk.to permite automatizar e gerenciar muitos aspectos da sua conta, simplificando tarefas e integrando o tawk.to aos seus sistemas existentes.
Você pode usar a API REST para:
Criar propriedades e convidar membros da equipe automaticamente
Recuperar listas filtradas de bilhetes, chats ou membros da propriedade
Visualizar estatísticas do chat por agente, etiqueta, departamento e data
Gerenciar webhooks
Criar e listar artigos da Base de Conhecimento
Criar e personalizar ferramentas do chat
OBSERVAÇÃO: A API REST foi criada para desenvolvedores ou qualquer pessoa à vontade em trabalhar com código. Se você é novo no uso de APIs, considere trabalhar com um desenvolvedor.
Para referências técnicas e atualizações, visite o Portal do Desenvolvedor do tawk.to.
Para saber mais sobre como usar webhooks, consulte este guia:
A API REST está disponível sob solicitação. Para começar:
1. Preencha o Formulário de Solicitação de Acesso à API REST.
2. Após a aprovação da sua solicitação, você receberá um nome de usuário, senha e um link para a documentação da API REST.
Depois de receber o acesso à API REST:
1. Faça login na sua conta do tawk.to.
3. Clique em Editar Perfil.
4. Clique em Chaves da API REST no menu à esquerda.
5. Clique em Criar Chave.
6. Sua nova chave aparecerá na lista.
Importante: Mantenha sua chave de API em segurança. Não a compartilhe com pessoas não autorizadas.
Para excluir uma chave, selecione-a e clique em Excluir.
Todas as solicitações da API REST devem:
Usar HTTPS
Usar Autenticação Básica HTTP com sua chave de API como nome de usuário no cabeçalho Authorization
A forma de configurar isso depende do seu cliente HTTP ou da linguagem de programação. A maioria já possui suporte integrado para Autenticação Básica.
Saiba mais sobre o cabeçalho de autorização HTTP aqui.
URL base: https://api.tawk.to/v1/
A API REST usa métodos HTTP no estilo RPC. Passe os parâmetros no corpo das solicitações POST, a menos que indicado de outra forma na documentação.
Obter os detalhes do agente atual
Endpoint: POST https://api.tawk.to/v1/agent.me
Autenticação: HTTP Basic (chave de API como nome de usuário)
Resposta: JSON com um indicador de sucesso; erros incluem um código de erro curto.
Solicitações bem-sucedidas retornam JSON com um indicador de sucesso claro.
Se algo der errado, a resposta incluirá um código de erro que você pode usar para depurar ou lidar com o problema.
Consulte sua documentação da API REST para obter a lista completa de métodos, parâmetros e códigos de erro.
Pergunte à nossa comunidade de desenvolvedores se tiver dúvidas sobre o uso da nossa API REST.
Segurança
Armazene suas chaves de API com segurança e faça a rotação delas regularmente.
Testes
Tente suas solicitações em um ambiente de testes antes de fazer alterações em produção.
Tratamento de erros
Planeje tentativas de repetição com intervalo progressivo em caso de problemas temporários.
Webhooks
Valide as cargas recebidas para confirmar que as solicitações são genuínas.
Alternativas
Se você só precisa personalizar a ferramenta no seu site, a API JavaScript pode ser mais simples que a API REST.
Se você tiver sugestões sobre este artigo ou precisar de mais ajuda:
- Clique no ícone verde de chat ao vivo
- Agende uma chamada conosco
- Visite nossa comunidade