Featured image for Dê seus primeiros passos com a API da Huggy

Experimente a nossa API de um jeito prático e conheça o potencial que ela traz para o seu negócio.


Você sabe o que é uma API e como ela pode beneficiar o seu negócio?

Preparamos este artigo para tirar suas dúvidas e facilitar o aprendizado dessa ferramenta tão adotada pelo mercado de tecnologia.

Continue a leitura e saiba como dar seus primeiros passos com exemplos da API da Huggy.

O que é API?

API é um conjunto de convenções que permite a comunicação entre sistemas.

Sabe quando você envia sua localização pelo WhatsApp?

Neste momento, o aplicativo se comunica com um sistema externo que disponibiliza a sua localização.

Esse é o benefício que a API oferece para o seu negócio: aproveitar funcionalidades de diversos sistemas nos mais variados contextos.

Quando utilizar a API da Huggy?

A API da Huggy é ideal para negócios em expansão. Conforme novos desafios surgem, é natural que você precise contar com funcionalidades de outras tecnologias para potencializar o seu Atendimento Digital.

Porém, isso exige uma solução que facilite a comunicação entre sistemas.

É aqui que entra a API da Huggy. Com ela, fica mais fácil:

  • Automatizar a criação de um novo contato em sistemas/ferramentas de CRM;

  • Criar uma rotina de exportação de relatórios dos atendimentos para o seu sistema de Business Intelligence (BI);

  • Coletar informações sobre seus agentes para análise de performance;

  • Desenvolver condições personalizadas para iniciar um atendimento com o seu cliente;

  • E muito mais.

Mesmo que hoje você não sinta a necessidade de realizar integrações como essas, a disponibilidade de uma API te dá segurança quando chegar o momento de escalar o seu negócio.

Que tal ver na prática?

Vamos testar juntos a API da Huggy, solicitando a lista de contatos da sua conta?

Um sistema pode solicitar um recurso a outro por meio do que chamamos de requisição.

Para te ajudar a realizar sua primeira requisição de uma forma bastante simples, vamos nos comunicar com a API da Huggy por meio do Google Apps Script.

Por questões didáticas, exploraremos as funcionalidades da API v2. É necessário que você tenha o perfil de Administrador para executar este exemplo.

Fazendo sua primeira requisição

Acesse a página do Apps Script e faça login com a sua conta do Google. Em seguida, clique no botão Novo projeto presente no menu lateral à sua esquerda.

Substitua o código padrão pelo código abaixo:

function consultaContatos() {
  var metodoEcabecalhos = {
    'method': 'get',
    'headers': {
      'Authorization': 'Bearer ' + '**coloque-aqui-seu-token**',
      'Content-Type': 'application/json',
      'Accept': 'application/json',
    },
  };
  Logger.log (UrlFetchApp.fetch(`https://api.huggy.app/v2/contacts/`, metodoEcabecalhos));
}

Por questões de segurança, algumas APIs exigem que você se identifique ao solicitar determinados recursos. Na Huggy, essa identificação acontece por meio de um código único, composto por números e letras, chamado token.

⚠️ Nunca compartilhe o seu token com pessoas não autorizadas.

Efetue agora o login na sua conta da Huggy, vá em Configurações > API e copie o token da sua conta.

Volte para a página do Apps Script e adicione o seu token no campo indicado abaixo:

Salve seu projeto e clique no botão Executar. Sua requisição será executada após você conceder as permissões de acesso solicitadas pelo Apps Script.

Vamos entender agora os detalhes da requisição que você acabou de fazer utilizando a API da Huggy.

Desvendando o exemplo

Toda requisição precisa especificar algumas informações na hora de se comunicar com um sistema. Elas definem, por exemplo, o tipo de dados que serão enviados e recebidos.

No nosso exemplo, criamos uma variável chamada metodoEcabecalhos para armazenar todas as informações da sua primeira requisição.

Esta variável corresponde a um objeto na linguagem JavaScript. Para saber mais sobre o que são objetos e como utilizá-los, clique aqui.

Veja a estrutura de metodoEcabecalhos no trecho de código abaixo:

var metodoEcabecalhos = {
    'method': 'get',
    'headers': {
      'Authorization': 'Bearer ' + 'token',
      'Content-Type': 'application/json',
      'Accept': 'application/json',
    }

O Método (Method)

Para indicar à API da Huggy qual ação queremos executar sobre um determinado recurso, definimos o método da requisição.

O exemplo que você acabou de testar para obter a lista de contatos da sua conta explorou o método GET, que solicita dados da API.

Os Cabeçalhos (Headers)

Headers são cabeçalhos que definem parâmetros como o tipo de dados e critérios de segurança.

Na nossa requisição, utilizamos:

  • Authorization: identifica qual conta fez a requisição para a API da Huggy.

O tipo bearer adiciona segurança à sua requisição por meio de um token.

  • Content-Type e Accept: especificam os formatos de dados da requisição e da resposta. 

A Huggy utiliza o conhecido padrão JSON.

O endpoint

O endpoint pode ser entendido como o endereço (URL) de acesso a um determinado recurso da API.

Por exemplo:

https://api.huggy.app/v2/contacts

Acesse nossa documentação para conhecer todos os endpoints disponíveis.

Etapa final da requisição

Por fim, chegou o momento de enviar a requisição para a API da Huggy. Essa tarefa aconteceu por meio do método UrlFetchApp.fetch, informando o endereço de destino da requisição (endpoint) e as informações de métodos e cabeçalhos.

Para fins didáticos, mostramos a resposta da requisição em tela usando outro método, o Logger.log:

Logger.log(UrlFetchApp.fetch(`https://api.huggy.app/v2/contacts/`, metodoEcabecalhos));

Quer continuar aprendendo?

Agora que você já teve seu primeiro contato com a nossa API, te convidamos a dar mais um passo.

Clique no botão abaixo e veja na prática como automatizar a exportação de todos os seus contatos diretamente para uma planilha do Google.