Como utilizar a API da Huggy?
CRIADO
por
Calebe Ribeiro
Com a API da Huggy, você desenvolve integrações e cria novas funcionalidades para otimizar processos e proporcionar uma experiência ainda mais personalizada aos seus clientes.
Nossa API é baseada no padrão REST e tem total compatibilidade com o formato JSON.
Cabeçalhos
Ao utilizar a API da Huggy, inclua em suas requisições os seguintes cabeçalhos:
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxxxxxx
O cabeçalho "Authorization" corresponde a um código exclusivo que garante acesso à sua conta. Mais detalhes serão fornecidos ao longo deste artigo.
Conhecendo a API v2
A API v2 é indicada para experimentar recursos, agilizar testes e validações na sua conta.
Método de autenticação
Nesta versão, 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 com um perfil de Administrador e em seguida vá para Configurações > API.
Conhecendo a API v3
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 para a sua segurança.
Você também precisará incluir um token de acesso em suas requisições para a API v3. A obtenção desse código segue um fluxo distinto que vamos mostrar a seguir.
Método de autenticação
Nossa API v3 utiliza o método OAuth 2.0 para autenticar o usuário e permitir a comunicação da plataforma com outros sistemas.
Para facilitar a criação de integrações simultâneas e garantir mais controle e segurança em suas operações, disponibilizamos a API v3 numa estrutura que chamamos de Aplicativos.
Cada aplicativo criado recebe as suas próprias credenciais de API e funciona como uma solução de integração independente das demais.
Para criar um aplicativo, acesse sua conta com um perfil de Administrador, clique em Configurações > Seus aplicativos. Clique em Adicionar Aplicativo, insira o nome desejado e clique em Adicionar.
Seu aplicativo será criado com suas próprias credenciais OAuth (client_id e client_secret).
A partir desse ponto, é necessário preparar seu sistema para realizar as chamadas e seguir com o fluxo de autenticação OAuth 2.0.
Você encontra na nossa documentação o passo a passo detalhado do fluxo de autenticação.
Utilize nossa solução de autenticação
Para facilitar a autenticação na API v3, temos uma solução pronta para uso desenvolvida no Google Planilhas. Ela inclui os códigos-fonte necessários para te auxiliar a implementar a autenticação em suas próprias integrações. Para acessar a solução, clique aqui.
Entendendo os limites da API
Com o objetivo de promover a estabilidade e o bom desempenho da nossa API, contamos com um limite de taxa de 20 requisições por segundo. Essa medida é crucial para evitar sobrecargas no sistema e assegurar que todos os usuários tenham uma experiência consistente.
