APIs
API é uma forma de facilitar a comunicação entre diferentes sistemas, permitindo que eles compartilhem informações de forma rápida e eficiente.
Nossa plataforma oferece diversas APIs que permitem integração com outras aplicações, possibilitando o envio de mensagens, início de fluxos, atualização de tags, consulta de status, gerenciamento de leads e muito mais.
API e Webhook resolvem problemas opostos. A API você chama quando quer alguma coisa; o Webhook avisa você quando algo acontece. Uma integração que fica consultando a API de tempos em tempos só para saber se chegou mensagem nova quase sempre deveria ser um Webhook.
Dúvidas Comuns
Preciso saber programar para usar a API? Para montar a integração, sim — alguém precisa escrever o código que faz a requisição. Os artigos desta seção entregam o endereço, o formato e um exemplo pronto, o que encurta muito o trabalho de quem programa, mas não substituem essa pessoa.
Qual é o endereço das APIs? Todas partem do endereço da sua instalação, no formato https://{BACKEND_URL}/api/..., e cada chamada acrescenta o seu próprio caminho. O artigo de cada chamada traz o endereço completo.
Dá para testar se está tudo certo antes de montar a integração inteira? Dá, e é o caminho recomendado: a chamada de Status da Conexão exige só o token e devolve o estado da Conexão. Se ela responder, autenticação e endereço estão corretos.