Como enviar anexos por variáveis vindas de API?


Os chatbots se adaptam às necessidades das empresas/clientes e cada bot realiza trabalhos diferentes. 
Muitas vezes é necessário enviar imagens ou arquivos que estão no banco de dados de um determinado sistema. Nós estamos prontos para atender essa demanda também! 

Vamos lembrar que sempre que um BOT resgata ou insere alguma informação em um sistema, essa interação de dados vem por meio de integrações com APIS. 

As APIS fazem a ponte entre as chamadas externas e o banco de dados dos sistemas. Essas chamadas para resgatar anexos servem para entregar em uma conversa aquivos como: PDF de nota fiscal, boleto, guias, documentos, ou, imagens de produtos, cardápio, etc. Qualquer arquivo que esteja salvo em um sistema e haja disponibilidade de entregá-lo via API.

Na maioria das vezes esses anexos são salvos no banco de dados em um formato Base64, que é uma forma de transformar o arquivo em texto para armazená-los em tabelas do banco de dados (bancos de esquema relacional). 

Para adicionar, em uma parte do fluxo, um anexo vindo de API nós precisamos saber:

  • Qual variável da integração com a API representa o anexo;
  • Qual a extensão desse arquivo;

Vamos usar de exemplo a entrega de boletos em PDF do BOT do Immobile Condominio.

Fazendo uma chamada na API, a variável que guarda a informação do boleto é a "BoletoIn64"


Na edição de fluxo, quando for cadastrada uma "Integração com API"  e for configurada esta API do immobile de entrega de boletos, a variável "BoletoIn64" será listada como uma variável encontrada. 



Nós sabemos que o boleto é um arquivo PDF, então para entregá-lo em um "Menu" ou "Mensagem Final" basta: 

  • Clicar em "Imagem"  dentro do card de Menu/Mensagem final→ Upload por API;
  • Selecionar a variável que contém o anexo que queremos entregar;
  • Selecionar a extensão do arquivo;



E Voillà! O Chabot estará enviando um documento armazenado no seu banco de dados! 


Observação

No campo variável, serão listadas todas as variáveis disponíveis pela API.
Existem APIS que contem apenas a variável do anexo, porém outras entregam diversas informações + anexo.
Portanto devemos tomar cuidado ao selecionar a variável correta e assim evitar erros no nosso fluxo.  




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 há um padrão ou obrigação onde as APIS que entregam anexos coloquem sempre o mesmo nome na variável. 
Para conseguirmos entregar devemos conhecer as APIS que estamos integrando e também testá-las antes para descobrir os campos disponíveis.