Todas as categorias > API > Guia prático para configurar a API e o Webhook da Huggy

Guia prático para configurar a API e o Webhook da Huggy

CRIADO por Calebe Ribeiro

Siga esse roteiro para ativar a API e o Webhook da Huggy.

1. Utilize um perfil de administrador

Após o cadastro, você será designado como um usuário Administrador na Huggy, perfil que possui os privilégios para a ativação da API.

Administradores também podem convidar novos usuários.

2. Crie um aplicativo

Com os aplicativos Huggy, você ativa a API e o Webhook. Esse recurso possibilita o desenvolvimento de integrações totalmente independentes.

Acesse Configurações > Seus aplicativos e crie um aplicativo.

3. Autentique o aplicativo

Utilize nossa solução de autenticação, ou implemente o fluxo OAuth 2.0 na linguagem de sua escolha.

Ao autenticar a API, um token de acesso será fornecido a você, o qual deve ser incorporado em todas as requisições.

Adicionalmente, é possível definir um endereço para o recebimento de eventos do Webhook; os detalhes desse procedimento serão explicados adiante neste tutorial.

Acesse aqui, mais detalhes sobre o fluxo OAuth 2.0.

4. Faça as requisições

Com a API ativada você poderá realizar as requisições GET, POST, PUT ou DELETE para http://api.huggy.app/v3.

Os seguintes cabeçalhos deverão ser incluídos nas requisições:

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

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.

Para usuários que administram múltiplas contas

Por padrão as requisições serão direcionadas à primeira conta associada ao administrador. Se o administrador gerencia várias contas, o ID da empresa desejada deve ser especificado na URI:

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

Para acessar o companyId, entre na plataforma, clique na sua foto de perfil e localize 'Empresa'.

5. Configure o Webhook

Após autenticar o aplicativo, você poderá escolher eventos do Webhook para receber em seu sistema, sem a necessidade de autenticação adicional.

Para configurar, 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 também disponibiliza um Webhook geral da conta com um processo de autenticação próprio. Porém, esta opção encaminha os eventos para um único sistema, o que pode restringir a implementação de integrações simultâneas. Por este motivo, indicamos utilizar a estrutura de aplicativos abordada nesse tutorial.

Conheça outras funcionalidades

Conheça também outros recursos da Huggy que viabilizam diversos tipos de integrações:

API e WhatsApp

Você pode utilizar a API da Huggy para disparar mensagens ativas no WhatsApp.

Efetuando requisições HTTP no Flow

Também é possível realizar requisições para APIs externas diretamente do fluxo conversacional. Clique aqui e entenda a funcionalidade de Enviar requisição do Flow.

Soluções práticas

Explore exemplos de soluções que vão te ajudar a entender as tecnologias da Huggy na prática:

Espaços de ajuda

Confira nossos espaços de ajuda:

Central de Ajuda: Tutoriais detalhados sobre a utilização da plataforma.
Spotlight: Novidades, dicas de negócios e soluções práticas para uso da Huggy.
Documentação técnica: Documentação abrangente sobre nossa API e funcionalidades avançadas.