Zum Hauptinhalt springen

Integration mit OpenAPI in SmartFlow

Einführung​

SmartFlow ermöglicht die Integration von externen APIs über den OpenAPI-Standard. Diese Funktion bietet Ihnen immense Flexibilität, um Ihre Workflows mit Drittanbieterdiensten zu verbinden, komplexe Aufgaben zu automatisieren und Ihre Geschäftsprozesse zu bereichern.

Warum OpenAPI in SmartFlow verwenden?​

  • Interoperabilität: Verbinden Sie SmartFlow mit jedem System, das mit OpenAPI kompatibel ist.
  • Erweiterte Automatisierung: Führen Sie API-Aufrufe durch, um Daten in Echtzeit zu senden oder abzurufen.
  • Zeitersparnis: Importieren Sie OpenAPI-Sammlungen, um vordefinierte Endpunkte ohne komplexe Konfiguration zu nutzen.

Screenshot: [Fügen Sie einen Screenshot hinzu, der die Importoberfläche einer OpenAPI-Sammlung von der Seite Einstellungen des Chatbots zeigt.]

Eine OpenAPI-Integration hinzufügen​

1. Eine OpenAPI-Sammlung importieren​

  1. Zugriff auf die Seite Einstellungen des Chatbots: Navigieren Sie zum Tab "Einstellungen" des betreffenden Chatbots.
  2. Eine Datei importieren oder über die Oberfläche konfigurieren: Klicken Sie auf "OpenAPI-Sammlung hinzufügen" und wählen Sie eine JSON- oder YAML-Datei aus oder konfigurieren Sie die Endpunkte direkt über die Oberfläche.
  3. Validierung: Die Endpunkte werden automatisch nach Sammlung sortiert und validiert.
  4. Speichern: Nach der Validierung stehen die Endpunkte als "API"-Aktionen in SmartFlow zur Verfügung.

Screenshot: [Zeigen Sie die Konfigurationsoberfläche auf der Seite Einstellungen des Chatbots.]

2. API-Aktionen in SmartFlow verwenden​

  1. Eine Aktion hinzufügen: Gehen Sie in Ihrem SmartFlow-Workflow zum Tab Aktionen und wählen Sie "API".
  2. Einen Endpunkt auswählen: Die Endpunkte sind nach Sammlung sortiert und für alle Arten von SmartFlows verfügbar.
  3. Parameter festlegen: Konfigurieren Sie die erforderlichen Felder für den Aufruf (Headers, Body usw.).
  4. Standardbeobachtung: Standardmäßig gibt jede API-Aktion das Ergebnis des Aufrufs als Beobachtung im "Conversation Tool"-Modus zurück, sodass die KI automatisch die nächste Entscheidung treffen kann.

Screenshot: [Fügen Sie einen Screenshot hinzu, der einen Endpunkt zeigt, der als API-Aktion in SmartFlow verwendet wird.]

Anwendungsbeispiel​

Szenario: Synchronisierung mit einem externen CRM​

  1. Ziel: Aktualisieren Sie die Informationen eines Kunden in Ihrem CRM, wenn ein Formular eingereicht wird.
  2. Workflow:
    • Trigger: Ein Benutzer füllt ein Formular über SmartForm aus.
    • API-Aktion: Senden Sie die Formulardaten an die API Ihres CRM.
    • Beobachtung: Das Ergebnis des Aufrufs wird automatisch als Beobachtung im "Conversation Tool"-Modus zurückgegeben.
  3. Vorteile: Zeitersparnis und Reduzierung manueller Fehler.

Screenshot: [Zeigen Sie einen vollständigen Workflow mit einem API-Aufruf, der mit einem CRM verbunden ist.]

Szenario: Abrufen von Benutzerdaten​

  1. Ziel: Passen Sie eine Antwort des Chatbots basierend auf den Benutzerdaten an.
  2. Workflow:
    • Trigger: Eine Benutzeranfrage im Chatbot.
    • API-Aktion: Abfragen einer externen API, um Benutzerdaten zu erhalten.
    • Beobachtung: Verwenden Sie die zurückgegebenen Daten als Beobachtung, um die nächste Antwort des Chatbots zu bestimmen.

Screenshot: [Veranschaulichen Sie eine Interaktion zwischen einem Chatbot und einer externen API.]

Best Practices​

  • Importieren Sie geprüfte Sammlungen: Stellen Sie sicher, dass Ihre OpenAPI-Dateien den Standards entsprechen, um Importfehler zu vermeiden.
  • Regelmäßig testen: Validieren Sie Ihre API-Aufrufe, um sicherzustellen, dass sie wie gewünscht funktionieren.
  • Dokumentieren Sie Ihre Integrationen: Fügen Sie klare Beschreibungen für jeden Endpunkt hinzu, um deren Verwaltung zu erleichtern.

Mit dieser Integration wird SmartFlow zu einer noch leistungsfähigeren Plattform, um Ihre Tools zu verbinden und Ihre Prozesse zu automatisieren. Gehen Sie zum nächsten Abschnitt, um den Template Store zu entdecken und Ihre Workflows zu teilen!