Integration mit OpenAPI in SmartFlow
Einführung
SmartFlow ermöglicht die Integration externer 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 Benutzeroberfläche zum Importieren einer OpenAPI-Sammlung von der Einstellungsseite des Chatbots zeigt.]
Hinzufügen einer OpenAPI-Integration
1. Importieren einer OpenAPI-Sammlung
- Zugriff auf die Chatbot-Einstellungsseite: Navigieren Sie zum Tab "Einstellungen" des entsprechenden Chatbots.
- Datei importieren oder über die Benutzeroberfläche konfigurieren: Klicken Sie auf "Eine OpenAPI-Sammlung hinzufügen" und wählen Sie eine JSON- oder YAML-Datei aus oder konfigurieren Sie die Endpunkte direkt über die Benutzeroberfläche.
- Validierung: Die Endpunkte werden automatisch nach Sammlung sortiert und validiert.
- Speichern: Nach der Validierung stehen die Endpunkte als Aktionen vom Typ "API" in SmartFlow zur Verfügung.
Screenshot: [Zeigen Sie die Konfigurationsoberfläche auf der Chatbot-Einstellungsseite.]
2. API-Aktionen in SmartFlow verwenden
- Aktion hinzufügen: Gehen Sie in Ihrem SmartFlow-Workflow zum Tab "Aktionen" und wählen Sie "API".
- Endpunkt auswählen: Die Endpunkte sind nach Sammlung sortiert und für alle Arten von SmartFlows verfügbar.
- Parameter definieren: Konfigurieren Sie die erforderlichen Felder für den Aufruf (Header, Body usw.).
- 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
- Ziel: Aktualisieren Sie die Kundeninformationen in Ihrem CRM, wenn ein Formular eingereicht wird.
- Workflow:
- Trigger: Ein Benutzer füllt ein Formular über SmartForm aus.
- API-Aktion: Senden Sie die Formulardaten an die API Ihres CRMs.
- Beobachtung: Das Ergebnis des Aufrufs wird automatisch als Beobachtung im "Conversation Tool"-Modus zurückgegeben.
- Vorteile: Zeitersparnis und Reduzierung manueller Fehler.
Screenshot: [Zeigen Sie einen vollständigen Workflow mit einem API-Aufruf, der mit einem CRM verknüpft ist.]
Szenario: Abrufen von Benutzerdaten
- Ziel: Personalisieren Sie eine Chatbot-Antwort basierend auf Benutzerdaten.
- Workflow:
- Trigger: Eine Benutzeranfrage im Chatbot.
- API-Aktion: Abfragen einer externen API, um Benutzerinformationen zu erhalten.
- Beobachtung: Verwenden Sie die zurückgegebenen Daten als Beobachtung, um die nächste Antwort des Chatbots zu entscheiden.
Screenshot: [Veranschaulichen Sie eine Interaktion zwischen einem Chatbot und einer externen API.]
Best Practices
- Importieren Sie verifizierte 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 beabsichtigt 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 leistungsstärkeren Plattform, um Ihre Tools zu verbinden und Ihre Prozesse zu automatisieren. Wechseln Sie zum nächsten Abschnitt, um den Template Store zu entdecken und Ihre Workflows zu teilen!