Karoo

Como criar variáveis de API

Você sabe o que é uma API?


https://media2.giphy.com/media/2KsdGPTzQHgbr0ncra/giphy.gif?cid=ecf05e478updw19gdzgylogszx4xcjv31fljbwux1er2j2b0&ep=v1_gifs_search&rid=giphy.gif&ct=g


Explicando de forma simples: uma API (Application Programming Interface) é um conjunto de regras que permite que diferentes sistemas "conversem" entre si. No Karoo Bot, as variáveis de API são fundamentais para a fluidez do atendimento, pois permitem que os dados recebidos de um sistema externo sejam exibidos diretamente no texto do chat! 😉

O fluxo da informação

Quando você utiliza o Card de Integração com API, a comunicação acontece em dois sentidos:

  1. Envio (Request): Você envia dados para a API (geralmente via método POST). No corpo da requisição, você insere as informações coletadas do cliente (como nome ou pedido).

  2. Retorno (Response): A API processa os dados e devolve uma resposta. É aqui que surgem as variáveis de API, que trazem os dados do sistema para dentro do bot.

Ao fazer uma requisição através de uma API que utiliza variáveis, o retorno da API trará os dados de acordo com as informações que foram passadas no corpo da requisição (o corpo da requisição nada mais é do que a informação que é enviada pelo cliente através da API).


Exemplo Prático: Pedido de Delivery 🍔

Imagine que o cliente fez um pedido. No corpo da requisição enviada para o seu sistema, usamos as variáveis de Resposta Livre que coletamos anteriormente: {{hamburguer}} e {{bebida}}.

Ao processar esse pedido, a API pode nos devolver variáveis confirmando os dados, como {{status_pedido}} ou {{valor_total}}.

https://ajuda.alterdata.com.br/kbot/files/269913024/336953687/1/1776713515628/Kooha-2026-04-20-16-30-36.gif

 


Importante: O nome dessas variáveis depende exclusivamente da API que você está integrando. Por isso, é fundamental consultar a documentação do sistema externo para saber exatamente quais nomes de campos eles utilizam (ex: alguns sistemas usam customer_name, outros apenas nome).