Saltar al contenido principal

Integración con OpenAPI en SmartFlow

Introducción​

SmartFlow permite la integración de APIs externas a través del estándar OpenAPI. Esta función te ofrece una inmensa flexibilidad para conectar tus flujos de trabajo a servicios de terceros, automatizar tareas complejas y enriquecer tus procesos de negocio.

¿Por qué usar OpenAPI en SmartFlow?​

  • Interoperabilidad: Conecta SmartFlow a cualquier sistema compatible con OpenAPI.
  • Automatización avanzada: Realiza llamadas a la API para enviar o recuperar datos en tiempo real.
  • Ahorro de tiempo: Importa colecciones de OpenAPI para usar puntos finales predefinidos sin configuración compleja.

Captura de pantalla: [Incluye una captura de pantalla que muestre la interfaz para importar una colección de OpenAPI desde la página de Configuración del chatbot.]

Agregar una Integración OpenAPI​

1. Importar una Colección OpenAPI​

  1. Acceder a la página de Configuración del Chatbot: Navega a la pestaña "Configuración" del chatbot relevante.
  2. Importar un archivo o configurar desde la interfaz: Haz clic en "Agregar una colección OpenAPI" y selecciona un archivo JSON o YAML, o configura los endpoints directamente desde la interfaz.
  3. Validación: Los endpoints se ordenan automáticamente por colección y se validan.
  4. Guardar: Una vez validados, los endpoints se convierten en acciones de tipo "API" en SmartFlow.

Captura de pantalla: [Mostrar la interfaz de configuración en la página de Configuración del Chatbot.]

2. Usar acciones de API en SmartFlow​

  1. Agregar una acción: En tu flujo de trabajo de SmartFlow, ve a la pestaña de Acciones y selecciona "API".
  2. Elegir un endpoint: Los endpoints están organizados por colección y disponibles para todos los tipos de SmartFlows.
  3. Definir parámetros: Configura los campos requeridos para la llamada (headers, body, etc.).
  4. Observación predeterminada: Por defecto, cada acción de API devuelve el resultado de la llamada como una observación en modo "Conversation Tool", permitiendo que la IA tome automáticamente la siguiente decisión.

Captura de pantalla: [Insertar una captura de pantalla que muestre un endpoint utilizado como una acción de API en SmartFlow.]

Ejemplo de Uso​

Escenario: Sincronización con un CRM externo​

  1. Objetivo: Actualizar la información del cliente en su CRM cuando se envía un formulario.
  2. Flujo de trabajo:
    • Disparador: Un usuario completa un formulario a través de SmartForm.
    • Acción de API: Enviar los datos del formulario a la API de su CRM.
    • Observación: El resultado de la llamada se devuelve automáticamente como una observación en modo "Herramienta de Conversación".
  3. Beneficios: Ahorro de tiempo y reducción de errores manuales.

Captura de pantalla: [Mostrar un flujo de trabajo completo con una llamada a la API vinculada a un CRM.]

Escenario: Recuperación de datos del usuario​

  1. Objetivo: Personalizar la respuesta de un chatbot basada en los datos del usuario.
  2. Flujo de trabajo:
    • Disparador: Una solicitud de un usuario en el chatbot.
    • Acción de API: Consultar una API externa para obtener información del usuario.
    • Observación: Utilizar los datos devueltos como una observación para decidir la siguiente respuesta del chatbot.

Captura de pantalla: [Ilustrar una interacción entre un chatbot y una API externa.]

Mejores Prácticas​

  • Importar colecciones verificadas: Asegúrate de que tus archivos OpenAPI cumplan con los estándares para evitar errores de importación.
  • Probar regularmente: Valida tus llamadas a la API para asegurarte de que funcionen como se espera.
  • Documentar tus integraciones: Agrega descripciones claras para cada endpoint para facilitar su gestión.

Con esta integración, SmartFlow se convierte en una plataforma aún más poderosa para conectar tus herramientas y automatizar tus procesos. ¡Pasa a la siguiente sección para descubrir la Tienda de Plantillas y compartir tus flujos de trabajo!