Cadastrar Entrar

Todas as categorias > Desenvolvedores > Como utilizar a API e o Webhook da Huggy

Como utilizar a API e o Webhook da Huggy

Calebe Ribeiro

Este guia de desenvolvimento reúne informações e referências para te ajudar a configurar a API da Huggy.

🧭 Acesso rápido
- Versão recomendada
- API v2
- API v3
- Cabeçalhos
- Requisições HTTP
- Webhook
- Recursos para WhatsApp
- Limite de requisições
- Fluxo conversacional
- Soluções práticas

Qual versão utilizar

A Huggy oferece duas versões da API (v2 e v3).

Chamamos atenção para a v2 que está em processo de descontinuação. Ela só é indicada para experimentar funcionalidades e agilizar testes.

A API v3 é a versão mais atual e a que recomendamos usar em suas integrações. Ela oferece mais recursos e conta com camadas de proteção extra.

API v2

Na API v2, o sistema disponibiliza um token para a sua conta que deve ser incluído em todas as requisições.

Para obter esse token, acesse a Huggy e em seguida vá para Configurações > API.

Por questões de segurança, ao gerar ou atualizar seu token, será necessário informar o código de verificação enviado para seu e-mail.

📢 Certifique-se de armazenar seu token de API em um local seguro, pois ele será exibido apenas uma vez.

Ao renovar o token, o anterior será desativado e não poderá mais ser utilizado.

💡 O token é único para toda a organização e pode ser renovado por todos administradores. Atualize-o em todos os sistemas integrados sempre que for feita uma renovação.

API v3

Você pode utilizar a API v3 criando um aplicativo Huggy.

Para isso, clique em sua foto de perfil e acesse Configurações > Seus Aplicativos e adicione um novo aplicativo.

💡 Certifique-se de estar utilizando um perfil de administrador.

Após criado, cada aplicativo receberá credenciais OAuth 2.0: client_id e client_secret.

Você deverá autenticar seu aplicativo para obter um token de acesso que será utilizado em todas as chamadas da API. Ele pode ser obtido diretamente em nossa documentação, clique aqui para acessar.

Cabeçalhos

Inclua os seguintes cabeçalhos nas suas requisições para a API:

Content-Type: application/json
Accept: application/json
Authorization: Bearer seu_token

Requisições

Após configurar o aplicativo e obter o token, você poderá realizar requisições GET, POST, PUT ou DELETE na URL base:

https://api.huggy.app/v3

Para administradores com múltiplas contas, especifique o companyId diretamente na URI da API.

https://api.huggy.app/v3/companies/companyId/recurso

Veja como localizar o companyId da sua conta:

Exemplo de requisição

Confira um exemplo de requisição GET no formato curl que retorna os 20 últimos atendimentos realizados na Huggy:

curl --location 'https://api.huggy.app/v3/chats' \
-header 'Content-Type: application/json' \
-header 'Accept: application/json' \
-header 'Authorization: Bearer {adicionar o token}' \
-header 'Accept-Language: pt-br'

Obtenha mais informações sobre as requisições em nossa documentação.

Webhook

Com o aplicativo autenticado, você poderá definir eventos do Webhook sem a necessidade de autenticação adicional:

Acesse o aplicativo na Huggy, selecione os eventos de interesse e informe a URL do sistema que irá recebê-los.

Certifique-se de que seu sistema possa processar requisições POST no formato dos eventos selecionados.

A Huggy oferece um Webhook geral da conta com um processo de autenticação próprio. Esta modalidade encaminha os eventos para um único sistema, o que pode restringir a implementação de integrações simultâneas.

Recursos para o WhatsApp

A API v3 oferece funcionalidades exclusivas para a comunicação no WhatsApp. Acesse aqui o material.

Limites

Para garantir estabilidade, nossa API possui um limite de 20 requisições por segundo.

A rota /chats tem um limite específico de 5 requisições por segundo. Respeitar esses limites é fundamental para manter o desempenho.

Requisições no fluxo conversacional

É possível integrar sistemas externos diretamente ao fluxo de conversas, sem a necessidade de utilizar os recursos da API da Huggy.

Para isso, você pode utilizar a ação Enviar requisição disponível no Flow.

Com essa funcionalidade, é possível realizar requisições HTTP para APIs em geral e processar suas respostas utilizando variáveis de contexto.

Clique aqui e entenda a funcionalidade de Enviar requisição do Flow.

Soluções práticas

Explore exemplos aplicados da API e o Webhook:

Esse artigo tirou suas dúvidas?

Primeira vez por aqui? Fale conosco e saiba como a Huggy pode gerar resultados reais para você usando conversas.

(opens in a new tab)