Pular para o conteúdo principal

Integração com OpenAPI no SmartFlow

Introdução​

O SmartFlow permite a integração de APIs externas via o 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 predefinidos sem configuração complexa.

Screenshot: [Inclua uma captura de tela mostrando a interface para importar uma coleção OpenAPI a partir da página de Configurações do chatbot.]

Adicionando uma Integração OpenAPI​

1. Importar uma Coleção OpenAPI​

  1. Acesse a página de Configurações do Chatbot: Navegue até a aba "Configurações" do chatbot relevante.
  2. 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.
  3. Validação: Os endpoints são automaticamente organizados por coleção e validados.
  4. Salvar: Uma vez validados, os endpoints ficam disponíveis como ações do tipo "API" no SmartFlow.

Captura de tela: [Mostrar a interface de configuração na página de Configurações do Chatbot.]

2. Use API Actions in SmartFlow​

  1. Add an action: In your SmartFlow workflow, go to the Actions tab and select "API".
  2. Choose an endpoint: The endpoints are sorted by collection and available for all types of SmartFlows.
  3. Define parameters: Configure the required fields for the call (headers, body, etc.).
  4. Default observation: By default, each API action returns the result of the call as an observation in "Conversation Tool" mode, allowing the AI to automatically make the next decision.

Screenshot: [Insert a screenshot showing an endpoint used as an API action in SmartFlow.]

Exemplo de Uso​

Cenário: Sincronização com um CRM externo​

  1. Objetivo: Atualizar as informações do cliente em seu CRM quando um formulário é enviado.
  2. Fluxo de Trabalho:
    • Gatilho: Um usuário preenche um formulário via SmartForm.
    • Ação da 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".
  3. Benefícios: Economia de tempo e redução de erros manuais.

Captura de tela: [Mostrar um fluxo de trabalho completo com uma chamada de API vinculada a um CRM.]

Cenário: Recuperando dados do usuário​

  1. Objetivo: Personalizar a resposta de um chatbot com base nos dados do usuário.
  2. Fluxo de Trabalho:
    • Gatilho: Um pedido de usuário no chatbot.
    • Ação da 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.

Captura de tela: [Ilustrar 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.
  • Teste regularmente: Valide suas chamadas de API para garantir que funcionem conforme o esperado.
  • Documente 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!