Integração com OpenAPI no SmartFlow
Introdução
O SmartFlow permite a integração de APIs externas através do padrão OpenAPI. Este recurso oferece imensa flexibilidade para conectar seus fluxos de trabalho a serviços de terceiros, automatizar tarefas complexas e enriquecer seus processos de negócios.
Por que usar OpenAPI no SmartFlow?
- Interoperabilidade: Conecte o SmartFlow a qualquer sistema compatível com OpenAPI.
- Automação avançada: Faça chamadas de API para enviar ou recuperar dados em tempo real.
- Economia de tempo: Importe coleções OpenAPI para usar endpoints pré-definidos sem configuração complexa.
Screenshot: [Inclua uma captura de tela mostrando a interface para importar uma coleção OpenAPI da página de Configurações do chatbot.]
Adicionando uma Integração OpenAPI
1. Importar uma Coleção OpenAPI
- Acesse a página de Configurações do Chatbot: Navegue até a aba "Configurações" do chatbot relevante.
- Importar um arquivo ou configurar pela interface: Clique em "Adicionar uma coleção OpenAPI" e selecione um arquivo JSON ou YAML, ou configure os endpoints diretamente pela interface.
- Validação: Os endpoints são automaticamente organizados por coleção e validados.
- Salvar: Uma vez validados, os endpoints ficam disponíveis como ações do tipo "API" no SmartFlow.
Screenshot: [Mostre a interface de configuração na página de Configurações do Chatbot.]
2. Usar Ações de API no SmartFlow
- Adicionar uma ação: No seu fluxo de trabalho do SmartFlow, vá até a aba Ações e selecione "API".
- Escolher um endpoint: Os endpoints são organizados por coleção e disponíveis para todos os tipos de SmartFlows.
- Definir parâmetros: Configure os campos necessários para a chamada (cabeçalhos, corpo, etc.).
- Observação padrão: Por padrão, cada ação de API retorna o resultado da chamada como uma observação no modo "Ferramenta de Conversa", permitindo que a IA tome automaticamente a próxima decisão.
Screenshot: [Insira uma captura de tela mostrando um endpoint usado como uma ação de API no SmartFlow.]
Exemplo de Uso
Cenário: Sincronização com um CRM externo
- Objetivo: Atualizar as informações do cliente no seu CRM quando um formulário é enviado.
- Fluxo de trabalho:
- Gatilho: Um usuário preenche um formulário via SmartForm.
- Ação de API: Enviar os dados do formulário para a API do seu CRM.
- Observação: O resultado da chamada é automaticamente retornado como uma observação no modo "Ferramenta de Conversa".
- Benefícios: Economia de tempo e redução de erros manuais.
Screenshot: [Mostre um fluxo de trabalho completo com uma chamada de API vinculada a um CRM.]
Cenário: Recuperando dados do usuário
- Objetivo: Personalizar a resposta do chatbot com base nos dados do usuário.
- Fluxo de trabalho:
- Gatilho: Um pedido de usuário no chatbot.
- Ação de API: Consultar uma API externa para obter informações do usuário.
- Observação: Usar os dados retornados como uma observação para decidir a próxima resposta do chatbot.
Screenshot: [Ilustre uma interação entre um chatbot e uma API externa.]
Melhores Práticas
- Importar coleções verificadas: Certifique-se de que seus arquivos OpenAPI estejam em conformidade com os padrões para evitar erros de importação.
- Testar regularmente: Valide suas chamadas de API para garantir que funcionem como esperado.
- Documentar suas integrações: Adicione descrições claras para cada endpoint para facilitar sua gestão.
Com esta integração, o SmartFlow se torna uma plataforma ainda mais poderosa para conectar suas ferramentas e automatizar seus processos. Vá para a próxima seção para descobrir a Template Store e compartilhar seus fluxos de trabalho!