Integração de APIs
Nesta seção, você aprenderá a criar e gerenciar APIs para interagir com sistemas externos, buscar dados de bases de conhecimento e integrar essas APIs perfeitamente aos fluxos conversacionais do seu bot usando o Advanced Builder.
❗️ Esta seção é destinada a usuários antigos cujo Use Case ainda não foi migrado para o Flow Builder. Todo novo Use Case deve ser criado no Flow Builder
Visão geral das APIs
Operações: Realize ações como buscar informações ou publicar atualizações em sistemas externos.
Busca de dados: Recupere dados das Knowledge Bases do seu bot para aprimorar as interações.
Grupos e gerenciamento de APIs
As APIs são organizadas em grupos, que funcionam como pastas para facilitar o gerenciamento. Você pode adicionar, editar ou excluir facilmente grupos e as APIs associadas a eles.
Ações
Dentro de uma API, você pode usar o menu no canto superior direito para duplicá-la ou excluí-la. A duplicação permite reutilizar a API em outra instância do bot.
Configuração da API
Nome: Escolha um nome descritivo para sua API, facilitando sua identificação nas conversas.
Ação do bot vinculada: Exibe onde a API é usada dentro do bot.
Grupo da API: Atribua a API a um grupo específico.
Tipo de API: Selecione entre API externa ou Knowledge Base.
URL: Defina a URL do serviço, com suporte a scripts Jinja para inserção de variáveis.
Método HTTP: Especifique o método (GET, POST, PUT, PATCH, DELETE).
Formato dos dados: Escolha entre JSON ou XML.
Cache: Defina intervalos de cache para otimizar o desempenho.
Cabeçalhos: Adicione cabeçalhos HTTP, com suporte ao formato JSON e ao Jinja para conteúdo dinâmico.
Entradas e extrações
Entradas: Defina e nomeie as variáveis necessárias para a execução da API.
Extrações: Isole e use os dados retornados pela API, utilizando JMESPath e scripts Jinja para manipulação precisa dos dados.
Solução de problemas comuns de APIs
Lista de permissões de IP: Certifique-se de que os IPs do backend da ViaSay estejam na lista de permissões do provedor da API.
Problemas com o User-Agent: Modifique o cabeçalho user-agent se a API de destino bloquear agentes baseados em Python.
Tempo de resposta: Certifique-se de que a API responda dentro dos limites de tempo aceitáveis (4 segundos para conectar, 16 segundos para concluir).
Tamanho da resposta da API: Gerencie os tamanhos das respostas para evitar problemas de desempenho, com tratamento específico conforme os limites de tamanho.