Como usar os blocos API e APIv2 no Ligo Bots

< 1 min

O bloco API no Ligo Bots permite realizar chamadas HTTP para APIs externas durante o fluxo do bot, integrando sistemas e automatizando processos. Existem duas versões disponíveis: API (v1) e APIv2.

Diferenças entre API v1 e API v2

  • API v1: Exige que a resposta da API siga um template predefinido para que os dados possam ser utilizados no fluxo.
  • API v2: Não possui modelo fixo de resposta, permitindo requisições para qualquer API e armazenamento do retorno com base no mapeamento JSON. É a versão mais recente e recomendada.

Configurações do bloco API v1

  • URL endpoint: Insira o endpoint da API.
  • Editar JSON payload: Configure o corpo da requisição em JSON, podendo adicionar variáveis do fluxo.
  • Método HTTP: Escolha o método (GET, POST, etc.).
  • Aguardar resposta da API: O bloco pode aguardar a resposta antes de prosseguir (tempo em milissegundos, padrão 10.000ms).
  • Ver formatos da resposta: Consulte os formatos de resposta suportados para garantir o correto processamento dos dados.

Configurações do bloco API v2

  • URL endpoint: Defina o endpoint da API.
  • Método HTTP: Escolha o método HTTP da requisição.
  • Adicionar Header: Adicione headers personalizados à requisição.
  • Editar JSON payload: Configure o corpo da requisição em JSON, com possibilidade de inserir variáveis do fluxo.
  • Variáveis: Mapeie os dados retornados pela API para variáveis do fluxo, usando o formato chave/valor do JSON de resposta.
    • Exemplo: Se a resposta for ‎`{“local”:”Brasil”,”DDI”:55,”moeda”:”Real”}`, você pode mapear cada valor para uma variável diferente.
  • Aguardar resposta da API: O bloco pode aguardar a resposta antes de avançar (tempo em milissegundos, padrão 10.000ms).
  • Mensagem de resposta durante processamento: Defina uma mensagem para o usuário enquanto a requisição está sendo processada.

O bloco API e APIv2 é essencial para integrar o Ligo Bots a sistemas externos, buscar informações em tempo real e automatizar tarefas complexas no fluxo do chatbot.