Entenda a ação Enviar requisição

Com a Huggy, suas conversas podem se conectar a serviços externos e se transformar em soluções poderosas.

Neste artigo, apresentaremos a ação Enviar requisição, um recurso exclusivo que amplia as funcionalidades do Flow.

Conheça algumas possibilidades:

  • Ofereça soluções baseadas em conversas: utilize um serviço externo para consultar se seu cliente tem direito a algum benefício ou desconto.
  • Conecte redes sociais e canais ao seu CRM: sincronize e mantenha os dados de seus clientes atualizados em sua plataforma de CRM.
  • Registre informações em tempo real: guarde feedbacks e outras informações relevantes em um banco de dados ou planilha on-line.
  • Faça muito mais: integre suas conversas com qualquer serviço que aceite requisições HTTP e aproveite as infinitas possibilidades do Flow.
Gostaria de um exemplo prático de como usar a ação Enviar requisição? Clique aqui e aprenda a integrar o Flow com uma API de demonstração que oferece segundas vias de boletos e certificados.

O que é uma requisição?

Antes de explicarmos a ação "Enviar requisição", é importante entender o conceito de uma requisição HTTP.

Pense em uma requisição HTTP como um pedido. É uma forma de comunicação usada entre dois sistemas, na qual um sistema solicita algo a outro.

Para ilustrarmos esse cenário, imagine um chatbot que apresenta um catálogo de produtos. Os detalhes de cada produto, como imagem, preço e descrição, não estão armazenados no chatbot, mas em um servidor que faz parte de outro sistema.

Quando o chatbot precisa fornecer tais detalhes durante a conversa, ele não possui essas informações diretamente. Em vez disso, ele pede ao servidor externo. Isso acontece por meio do envio de uma requisição HTTP, solicitando formalmente ao servidor os dados desejados.

Por que utilizar a ação Enviar requisição?

A ação Enviar requisição simplifica o processo de integração do chatbot, permitindo que você utilize a interface intuitiva do Flow para conectá-lo a outras ferramentas.

É possível conectar conversas com uma ampla variedade de APIs e serviços externos, sem precisar criar manualmente as requisições usando o protocolo HTTP.

Quais as funcionalidades da ação Enviar requisição?

A ação Enviar requisição permite personalizar configurações e parâmetros correspondentes ao sistema que se deseja integrar ao Flow:

Vamos entender agora como configurar cada uma das opções presentes na ação Enviar Requisição: Método e URL, Cabeçalho (Header) e Processar Resposta.

Método e URL

Aqui você escolhe dentre os principais métodos de requisição HTTP: GET, POST, PUT, PATCH e DELETE.

Em seguida, há um campo chamado URL destinado ao endereço do serviço específico da API (conhecido como endpoint) que você deseja integrar ao seu fluxo no Flow.

As variáveis de contexto do Flow são usadas para compor o conteúdo das requisições, usando o formato {{sua-variável}}. Por exemplo, é possível incorporar dinamicamente o nome de um contato na URL da requisição, como em: "https://endpoint-da-api/{{nome-do-contato}}".

Cabeçalho (Header)

Nesta seção, você pode indicar os cabeçalhos que fornecerão informações adicionais sobre a requisição. Esses cabeçalhos descrevem aspectos importantes da solicitação que você está fazendo.

Consulte a documentação da API do serviço que você deseja conectar ao Flow para conhecer quais são os cabeçalhos que devem estar presentes na requisição.

Corpo da mensagem

O corpo da mensagem descreve o conteúdo da sua requisição.

Em Tipo do layout, você tem a liberdade de escolher entre o formato chave-valor ou o JSON puro. 

Processar resposta

Esse é um recurso opcional que você pode usar para utilizar as informações presentes na resposta do servidor no seu fluxo conversacional.

Mas como isso funciona?

Vamos supor que uma API envia para o Flow uma resposta JSON no seguinte formato:

{
"id" : "141",
"nome": "Higgor",
"plano":  "7",
}

O Flow converte as chaves id, nome e plano em variáveis de contexto, respectivamente {{id}}, {{nome}} e {{plano}}.

Se a estrutura do JSON contiver vários níveis, como no exemplo abaixo:

{
"cliente":{
"id" : "141",
"nome" : "Higgor",
"contrato" :{
"id": "0001",
"plano" : "7"
}
},
"protocolo" : "20230631102321"
}

Neste caso, o Flow gera variáveis respeitando a estrutura do JSON, de modo que os elementos em níveis mais profundos podem ser referenciados como se fossem atributos dos elementos mais próximos da raiz.

Veja como fica no caso do nosso JSON de exemplo:

{{cliente.id}} = 141
{{cliente.nome}} = Higgor
{{cliente.contrato.id}} = 0001
{{cliente.contrato.plano}} = 7
{{protocolo}} = 20230631102321

O Flow processa até dez níveis na hierarquia do JSON.

Utilizando o campo “variables”

Quando o JSON recebido pelo Flow contém um campo nomeado como variables, as informações presentes nele têm prioridade na geração de variáveis de contexto.

Considere o exemplo:

{
"nome": "Higgor",
   "endereco": "Rua das Flores, 130",
   "variables": {
    "nome": "Oliver",
     "endereco": "Avenida das Laranjeiras, 670"
  }
}

Neste caso, os valores considerados para as variáveis de contexto {{nome}} e {{endereco}} são "Oliver" e "Avenida das Laranjeiras, 670", respectivamente.

Como configurar a ação Enviar requisição no Flow?

Para configurar a ação Enviar requisição, você precisa personalizar os parâmetros de acordo com os padrões definidos pelo sistema que se deseja integrar.

Agora que você já sabe como funciona essa poderosa ação do Flow, convidamos você para conhecer um exemplo prático de tudo o que aprendeu neste artigo.

Clique aqui e veja um exemplo de como conectar o Flow a uma API que emite documentos para o cliente diretamente no chat.


O que você achou deste artigo?


some text
Powered by HelpDocs (opens in a new tab)