Como enviar anexos por variáveis vindas de API?


Os chatbots são versáteis e, muitas vezes, precisam enviar arquivos que estão armazenados diretamente no banco de dados de um sistema externo. Seja um boleto, uma nota fiscal ou a imagem de um produto, o Karoo Bot está preparado para realizar essa entrega automaticamente.

O papel das APIs e do Base64

Sempre que o bot resgata informações de um sistema externo, ele utiliza uma Integração com API. Na maioria das vezes, arquivos (PDFs, imagens, documentos) são armazenados nesses bancos de dados no formato Base64 — uma codificação que transforma o arquivo em uma sequência de texto para facilitar o armazenamento e o transporte de dados.

O que você precisa saber antes de configurar:

Para entregar um anexo vindo de uma API, você precisará identificar dois pontos:

  1. Qual variável da API contém o conteúdo do arquivo (o código Base64).

  2. Qual a extensão original desse arquivo (ex: .pdf, .jpg, .png).

Exemplo Prático: Entrega de Boleto em PDF

Imagine que estamos configurando a entrega de um boleto. Ao testar a API, identificamos que a variável que guarda o arquivo se chama BoletoIn64.



Passo a passo no fluxo:

  1. Configure a Integração: Após configurar o Card de Integração API, a variável BoletoIn64 aparecerá na lista de variáveis encontradas.


      2. Adicione ao Card: No card de Menu ou Mensagem Final onde deseja entregar o arquivo:

  • Clique no ícone de Arquivo/Imagem;

  • Selecione a opção Upload por API;

  • No campo Variável, selecione a variável correspondente (ex: BoletoIn64);

  • No campo Extensão, selecione o formato correto (neste caso, PDF).



Voilà! O chatbot agora enviará o documento convertido diretamente do seu banco de dados para o cliente. 🚀


Observação

⚠️ Atenção ao selecionar as variáveis

No campo de seleção, serão listadas todas as variáveis retornadas pela sua API. Algumas APIs retornam apenas o anexo, enquanto outras trazem diversos dados misturados.

Dica: Certifique-se de selecionar exatamente a variável que contém o código Base64 para evitar erros no envio do arquivo.




Lista de Arquivos

                                                             "É o que que esse botão faz, hein?" 



Existem APIS que entregam mais de um documento de uma vez só. Então a variável que guarda o anexo, pode responder com uma lista de arquivos.


Neste caso, para atender esse tipo de entrega precisaremos marcar "Lista de arquivos"  abaixo das variáveis disponíveis e selecionar qual delas entregará os anexos.

Ao marcar a opção "Lista de Arquivos" serão apresentadas as mesmas variáveis, porém com um símbolo de colchetes na frente do nome. Se na nossa API de exemplo, o Immobile entregasse uma lista de arquivos na variável "BoletoIn64" a variável seria configurada assim: 

 





Dicas

Não existe um padrão universal para nomes de variáveis em APIs (algumas usam anexos, outras documentos ou files). Por isso, é fundamental:

  • Conhecer a documentação da API que você está integrando.

  • Executar testes prévios no card de integração para identificar exatamente quais campos trazem os arquivos.

Dessa forma, você garante que o fluxo entregue todos os documentos corretamente ao cliente, sem erros de processamento! 🚀