Zum Haaptinhalt sprangen

Integration with OpenAPI in SmartFlow

Introduction​

SmartFlow allows the integration of external APIs via the OpenAPI standard. This feature offers you immense flexibility to connect your workflows to third-party services, automate complex tasks, and enrich your business processes.

Why use OpenAPI in SmartFlow?​

  • Interoperability: Connect SmartFlow to any system compatible with OpenAPI.
  • Advanced automation: Make API calls to send or retrieve data in real-time.
  • Time-saving: Import OpenAPI collections to use predefined endpoints without complex configuration.

Screenshot: [Include a screenshot showing the interface for importing an OpenAPI collection from the chatbot's Settings page.]

Adding an OpenAPI Integration​

1. Import an OpenAPI Collection​

  1. Access the Chatbot Settings page: Navigate to the "Settings" tab of the relevant chatbot.
  2. Import a file or configure from the interface: Click on "Add an OpenAPI collection" and select a JSON or YAML file, or configure the endpoints directly from the interface.
  3. Validation: The endpoints are automatically sorted by collection and validated.
  4. Save: Once validated, the endpoints become available as "API" type actions in SmartFlow.

Screenshot: [Show the configuration interface in the Chatbot Settings page.]

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.]

Usage Example​

Scenario: Synchronization with an external CRM​

  1. Objective: Update customer information in your CRM when a form is submitted.
  2. Workflow:
    • Trigger: A user fills out a form via SmartForm.
    • API Action: Send the form data to your CRM's API.
    • Observation: The result of the call is automatically returned as an observation in "Conversation Tool" mode.
  3. Benefits: Time-saving and reduction of manual errors.

Screenshot: [Show a complete workflow with an API call linked to a CRM.]

Scenario: Retrieving user data​

  1. Objective: Personalize a chatbot response based on user data.
  2. Workflow:
    • Trigger: A user request in the chatbot.
    • API Action: Query an external API to obtain user information.
    • Observation: Use the returned data as an observation to decide the next response of the chatbot.

Screenshot: [Illustrate an interaction between a chatbot and an external API.]

Best Practices​

  • Import verified collections: Ensure that your OpenAPI files comply with standards to avoid import errors.
  • Test regularly: Validate your API calls to ensure they work as intended.
  • Document your integrations: Add clear descriptions for each endpoint to facilitate their management.

With this integration, SmartFlow becomes an even more powerful platform to connect your tools and automate your processes. Move to the next section to discover the Template Store and share your workflows!