API e Webhooks
Quando a integração que a sua operação precisa não existe em catálogo nenhum, ela é construída sobre a API da Hust. O sistema é aberto nos dois sentidos: a sua aplicação comanda a plataforma por requisições HTTP, e a plataforma avisa a sua aplicação quando algo acontece, por webhook ou WebSocket.
Para quem é
Times de tecnologia e parceiros que querem ligar o próprio produto ou o sistema interno da empresa ao atendimento.
- REST em JSON
- corpo e resposta, sempre
- Webhook ou WebSocket
- duas formas de receber evento
- Docs pública
- docs.hustapp.com
O que muda na prática
Envio pelo seu sistema
A sua aplicação dispara mensagem de texto e mídia pelas conexões de WhatsApp da empresa, sem ninguém abrir a plataforma.
Recebimento em tempo real
O que chega no atendimento é entregue à sua aplicação assim que acontece, por requisição HTTP ou por conexão persistente.
O atendimento dentro do seu produto
Para quem desenvolve software, é o caminho para embutir a comunicação no próprio fluxo do sistema que o cliente já usa.
Sem esperar catálogo
Nenhuma integração fica bloqueada por não existir um conector pronto. O que a API cobre pode ser construído agora.
Como funciona, passo a passo
O caminho que o dado percorre, na ordem em que acontece.
- 01
Você obtém o token de acesso
A maior parte das rotas exige um token enviado no cabeçalho Authorization. A documentação explica como obtê-lo.
- 02
A sua aplicação chama a API
As requisições vão para a URL base da API, com corpo e resposta em JSON. É por aí que saem o envio de mensagem e o envio de mídia.
- 03
Você escolhe como receber
Para o caminho de volta há duas opções: webhook, em que a Hust faz uma requisição HTTP para um endereço seu, ou WebSocket, mantendo uma conexão aberta.
- 04
O seu sistema reage
A partir do evento recebido, a sua aplicação decide o que fazer: registrar, consultar outro sistema, responder pela API.
O que mais vale saber
Webhook ou WebSocket
O webhook é mais simples de operar e sobrevive a reinício da sua aplicação, porque a Hust reentrega quando o seu endereço volta a responder. O WebSocket evita expor um endereço público e é o caminho natural quando a aplicação já mantém conexão persistente. As duas formas entregam o mesmo conteúdo.
O que a documentação cobre hoje
A referência pública documenta autenticação e o módulo de Chat: envio de mensagem, envio de mídia e as duas formas de recebimento. Integrações que precisam de mais do que isso são desenhadas junto com a equipe técnica.
Apoio na implementação
A integração não é jogada por cima do muro em uma documentação. A equipe técnica da Hust acompanha o desenho e a implementação, inclusive nos casos que fogem do que está documentado.
Quando preferir o n8n
Se a automação não exige código próprio, o n8n resolve o mesmo tipo de ligação por fluxo visual, chamando esta mesma API por baixo.
O que é preciso para ativar
A configuração é conduzida pela equipe da Hust. Do seu lado, o que precisa estar pronto é isto.
- Uma conexão de WhatsApp ativa na plataforma.
- Token de acesso à API.
- Um endereço acessível pela internet, se a escolha for receber por webhook.
Perguntas frequentes
Onde fica a documentação da API?
Em docs.hustapp.com. Ela cobre a autenticação por token e o módulo de Chat, com envio de mensagem, envio de mídia e as duas formas de receber o que chega.
Como funciona a autenticação?
Por token enviado no cabeçalho Authorization, exigido na maior parte das rotas. As requisições usam JSON no corpo e na resposta.
Webhook ou WebSocket, qual escolher?
Webhook quando você prefere receber uma requisição HTTP em um endereço seu, o que é mais simples de operar e tolera reinício da aplicação. WebSocket quando você não quer expor endereço público ou já mantém conexão persistente. As duas entregam o mesmo conteúdo.
Existe custo para usar a API?
A API faz parte da plataforma e não é vendida como módulo separado. O que pesa na conta é o mesmo de sempre: usuários e conexões, mais o custo das mensagens cobrado pela Meta nas conexões homologadas.
