Índice:

1. Vídeo orientativo
2. O que é uma requisição HTTP?
3. Situações em que podemos utilizar uma requisição HTTP no Builder
4. Como fazer uma requisição HTTP no Builder?
5. Exemplo de Requisição HTTP com autenticação

Aprenda o que é uma requisição HTTP, situações em que podemos utilizar uma requisição HTTP e como fazer uma requisição HTTP no Builder para obter dados de um usuário a partir de seu CEP ou CPF, assim como de um pedido de e-commerce a partir do código do pedido.

Vídeo orientativo 

O que é uma requisição HTTP?

Quando um site na internet é acessado, o navegador (Google, Edge, Opera etc) envia uma requisição HTTP para o servidor, solicitando uma informação específica. O servidor procura o que foi solicitado em seus arquivos, e quando encontra envia o que foi encontrado como uma resposta que é interpretada pelo navegador, exibindo em forma de site em uma tela.

De forma técnica, o HTTP é um protocolo baseado em streams de texto. Trata-se de um protocolo de comunicação e transferência de páginas HTML. Resumidamente, o cliente envia requisições (requests), e recebe do servidor as respostas (responses), conforme representado na figura a seguir.

O protocolo HTTP define um conjunto de métodos de requisição responsáveis por indicar a ação a ser executada para um dado recurso. Exemplo de métodos: GET, POST, PUT, DELETE, PATCH

Utilizaremos como exemplo os métodos GET e POST para realizar uma requisição HTTP dentro do Blip e para isso precisamos preencher alguns campos indicando o que queremos em nosso pedido.

• Método GET: Às requisições do tipo GET são recomendadas para obter dados de um determinado recurso.
• Método POST: As requisições POST são mais utilizadas para enviar informações para serem processadas, como por exemplo, criar algum recurso, como um produto, ou um cliente.

Situações em que podemos utilizar uma requisição HTTP no Builder

• Obter o endereço completo de um usuário a partir de seu CEP;
• Obter dados como o nome, endereço ou a filiação de um usuário a partir de seu CPF;
• Obter dados de um pedido de e-commerce a partir do código do pedido;

Observação: caso a API utilizada seja pública, não é necessário nenhum método de autenticação.

Como fazer uma requisição HTTP no Builder?

Segue um exemplo passo a passo de como realizar requisições HTTP pelo Builder. Nesse exemplo, o objetivo é obter os dados de um endereço de um usuário a partir do CEP digitado. Para isso utilizaremos a API pública dos correios.

1) O Primeiro passo é CRIAR O SEU FLUXO DE CHATBOT e IDENTIFICAR EM QUAL BLOCO O USUÁRIO DIGITARÁ A INFORMAÇÃO que será buscada na API.

2) Neste bloco, CLIQUE NA MENSAGEM EM QUE O USUÁRIO DIGITARÁ A INFORMAÇÃO QUE SERÁ ARMAZENADA e posteriormente buscada na API.

3) Após clicar na mensagem, clique em “SALVAR RESPOSTA EM VARIÁVEL” e digite um nome de seu interesse no campo “VARIÁVEL” (neste caso o CEP). Assim, a informação digitada pelo usuário será salva e ele poderá utilizar esta variável posteriormente.

4) Em seguida, acesse a opção “AÇÕES” no menu superior deste mesmo bloco.

5) A partir disso, deslize a barra e em “AÇÕES DE SAÍDA” clique em: “ADICIONAR CONDIÇÕES DE SAÍDA”, selecione: “REQUISIÇÃO HTTP”.

6) Após selecionar o tipo do método (GET ou POST) é preciso que você DIGITE A URL DA API onde será solicitada a requisição e o NOME DA VARIÁVEL armazenada (criada no passo 2) ENTRE CHAVES para efetuar a busca de acordo com o que o usuário digitou.

7) Após isso, no bloco onde teremos a resposta do bot de acordo com a resposta da requisição HTTP é preciso clicar em “AÇÕES” → ADICIONAR AÇÃO DE ENTRADA → EXECUTAR SCRIPT

8) Na parte de script, crie uma função que receberá a variável entrada. Dentro da função, crie uma variável que receberá “JSON.parse(entrada)” e em seguida, retorne à propriedade desejada.

Salve a variável de resposta no campo “VARIÁVEIS DE ENTRADA”, como no exemplo abaixo com: “corpocep”, para que ela possa ser retornada no chat. As variáveis de entrada são recebidas como parâmetro na função JavaScript.

9) As variáveis criadas são utilizadas entre chaves no bloco do bot e são substituídas pelos valores encontrados após a requisição.

10) Pronto! Agora, na visão do usuário, ao utilizar o chatbot, as mensagens são exibidas da seguinte maneira demonstrada abaixo:

11) Caso precise alterar algo no script, clique em “EXECUTAR SCRIPT” e acesse o script salvo. Você já pode testar o seu chatbot!

 Exemplo de Requisição HTTP com autenticação

A seguir vamos exemplificar como realizar uma requisição HTTP contendo a autenticação do BLIP. Nesse exemplo, desejamos obter os emails de todos os usuários que informaram seu email ao chatbot. 

Por exemplo, vamos supor que 10 pessoas utilizaram o chatbot e informaram o seu próprio email. Por meio dessa requisição HTTP, obtemos os 10 e-mails digitados por essas pessoas. Essa requisição também pode ser utilizada para obter, o telefone, CPF, nome entre outros dados digitados pelo usuário.

• Get contacts:
  
  

1. O primeiro passo é criar um bloco onde serão solicitadas as informações desejadas. Em nosso exemplo, solicitamos o e-mail do usuário no bloco “Boas Vindas”.

2. No texto de entrada do usuário, clique no texto e habilite a opção: “SALVAR RESPOSTA EM VARIÁVEL”, em seguida digite um nome para essa variável. Dessa forma, você está armazenando a resposta digitada pelo usuário, com o objetivo de não perder esse dado.

3. Crie um novo bloco, neste bloco será executada a requisição HTTP. Em nosso exemplo, esse bloco é o bloco “Buscando Contatos”.

4) Acesse a aba “AÇÕES”, clique em “ADICIONAR AÇÃO DE ENTRADA" e selecione “REQUISIÇÃO HTTP”.

5) Acesse a requisição a ser utilizada no BLIP Docs e confira se o método é POST ou GET. Assim, preencha o tipo do método no 1 º campo do Builder. Em seguida, copie a URL ao lado do tipo do método, em nosso exemplo a URL é: https://{{contract_id}}.http.msging.net/commands e cole no 2º campo do Builder, seguindo as imagens abaixo

6) Em seguida, clique no ícone de configurações no lado superior direito da tela:

7) Acesse “INFORMAÇÕES DE CONEXÃO” no menu lateral esquerdo:

8) Role a página até o final e encontre “ENDPOINTS HTTP”, copie o primeiro campo “CABEÇALHO DE AUTENTICAÇÃO (AUTHORIZATION)”. 

9) Retorne no bloco onde você criou a Ação de Requisição HTTP, na aba de AÇÕES → “REQUISIÇÃO HTTP”, acesse “CABEÇALHOS” e digite “AUTHORIZATION” no campo “KEY” e cole o texto anteriormente copiado no campo “VALUE”.

10) Retorne ao BLIP Docs  e copie o “BODY” da requisição:

{

"id": "{{$guid}}",

"to": "postmaster@crm.msging.net",

"method": "get",

"uri": "/contacts?$skip=0&$take=3"

}

11) Dentro de Requisição HTTP, acesse “CORPO” e cole o código copiado.

12) Abaixo de “CORPO”, vá em “SALVAR RESPOSTA” e preencha os campos com o nome de sua preferência para armazenar as respostas obtidas.

13) Crie um novo Bloco, onde será exibido o retorno da requisição. Crie um texto com a variável “RETORNO” criada no passo anterior. 

• Certifique-se de que o nome da variável está igual ao que você criou e de que a variável está entre duas chaves.

14) Clique no ÍCONE DE FOGUETE para publicar o fluxo e em seguida no ícone de testar o bot:

15) Ao testar o bot, assim que o usuário digitar o email, a variável {{retorno}} irá retornar todos emails dos contatos, ou seja, dessa forma é possível obter os emails digitados pelos usuários no chatbot por meio de uma requisição HTTP!

Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃