Mit dem Schritt API-Aufruf durchführen können Sie einen API-Aufruf an ein internes CRM- oder ERP-System o. ä. konfigurieren oder Details zur Konversation an einen externen Endpunkt wie Amazon Event Bridge oder Google Analytics übertragen.
In diesem Beitrag erfahren Sie, wie Sie diesen Schritt in einen Bot-Konversationsfluss einbinden und konfigurieren.
Allgemeine Informationen zum Schritt API-Aufruf durchführen und den entsprechenden Konfigurationsregeln finden Sie im Beitrag Überblick über die Schrittarten im Bot-Konversationsfluss: API-Aufruf durchführen.
Dieser Beitrag enthält die folgenden Abschnitte:
Hinzufügen des Schritt „API-Aufruf durchführen“ zu einem Bot
Um den Schritt API-Aufruf durchführen zu einem Bot hinzuzufügen, sind mehrere Aufgaben erforderlich.
Bei den untenstehenden Anweisungen wird vorausgesetzt, dass Sie bereits einen Bot-Konversationsfluss erstellt haben, zu dem Sie diesen Schritt hinzufügen möchten.
So fügen Sie den Schritt „API-Aufruf durchführen“ hinzu
- Öffnen Sie den Bot im Flow Builder.
- Klicken Sie an der Stelle, an der Sie den Schritt einfügen möchten, auf das Symbol Neu hinzufügen: entweder am Ende einer Verzweigung oder zwischen zwei vorhandenen Schritten.
- Klicken Sie im Konfigurationsfenster auf API-Aufruf durchführen.
- Geben Sie aussagekräftige Informationen zu diesem Schritt ein. Die hier eingegebenen Informationen sind nur für Ihr Team sichtbar, nicht für Kunden.
- Name: Ein Name, an dem Ihr Team den Aufruf leicht erkennt.
- Beschreibung (optional): Eine kurze Beschreibung der durch den Anruf ausgelösten Aktion.
- Fahren Sie wie im nächsten Abschnitt unter Hinzufügen von API-Details beschrieben fort.
Hinzufügen von API-Details
Konfigurieren Sie im Abschnitt „API-Details“ den gewünschten HTTP-Aufruf, indem Sie die HTTP-Anfragemethode und den Standort der externen Ressource angeben sowie bei Bedarf weitere Header hinzufügen. Die folgenden Schritte sind eine Fortsetzung des im vorherigen Abschnitt beschriebenen Verfahrens.
So fügen Sie die API-Details hinzu
- Klicken Sie im Konfigurationsfenster auf API-Details.
- Klicken Sie in der Dropdownliste auf eine Anfragemethode:
- GET ruft Daten von einem Server bei der externen Ressource ab. Dies ist die am häufigsten verwendete Methode.
- POST sendet Daten, um eine Ressource in einem externen System zu erstellen oder zu aktualisieren. Wenn die Ressource bereits vorhanden ist, wird sie durch die gesendeten Daten geändert.
- PUT sendet Daten, um eine Ressource zu aktualisieren oder zu erstellen. Wenn die Ressource bereits vorhanden ist, wird sie durch die gesendeten Daten ersetzt.
- PATCH sendet Daten, um eine Ressource an einem externen Standort zu aktualisieren. Mit dieser Methode werden Teile der Ressource verändert.
- DELETE entfernt die Ressource am externen Standort.
- Geben Sie eine Endpunkt-URL ein. Die Endpunkt-URL ist der Standort der externen Ressource, zu der eine Verbindung hergestellt werden soll. Die Endpunkt-URL unterstützt das
https://-Protokoll. - Wählen Sie optional eine Verbindung zur Authentifizierung des API-Aufrufs. Hinweis: Sie müssen eine Verbindung herstellen, bevor Sie den API-Aufruf authentifizieren.
- Geben Sie bei Bedarf den Schlüssel und den Wert für einen optionalen Header ein.Wichtig: Verwenden Sie für Authentifizierungstypen keine HTTP-Header, sondern stattdessen API-Verbindungen.
Wenn der Schritt API-Aufruf durchführen authentifizierungsbezogene Header wie
authorizationoderx-api-keyenthält, schlägt er automatisch fehl. Wenn ein Schritt API-Aufruf durchführen fehlschlägt, folgt die Konversation den Schritten der Verzweigung API-Aufruf fehlgeschlagen. - Klicken Sie auf API-Aufruf durchführen, um den API-Aufruf zu testen. Wenn zur URL oder zum Header des Schritts Variablen hinzugefügt werden, können Sie optionale Testdaten für Ihren externen Service eingeben, um zu prüfen, ob der API-Aufruf wie erwartet funktioniert. Beachten Sie, dass hierbei eine HTTP-Anfrage an die konfigurierte Endpunkt-URL gesendet wird.
Speichern der API-Antwort als Variable
API-Antworten können in einer Variablen gespeichert werden. Variablen werden auf verschiedene Weise verwendet:
- Personalisieren der Bot-Nachricht an Kunden. Sie können beispielsweise den Namen eines Kunden als Variable speichern und diese in einer Bot-Nachricht verwenden. Variablen können an einer beliebigen Stelle nach dem Schritt API-Aufruf durchführen, durch den sie erstellt wurden, in Schritte mit einer konfigurierbaren Nachricht in den Konversationsfluss eingefügt werden:
-
Übergeben von Daten im Aufruf an ein externes System. Sie können zum Beispiel einen Kunden bitten, eine Bestellnummer anzugeben, und anschließend per API-Aufruf an Ihr E-Commerce-System den Versandstatus für die betreffende Bestellung abrufen. Im Hinblick auf die Verwendung von Variablen im Schritt API-Aufruf durchführen sind bestimmte Einschränkungen zu beachten.
Im Feld „Endpunkt-URL“ können Variablen nur zu URL-Pfaden oder Query-Zeichenfolgen hinzugefügt werden, nicht zur Domäne oder Subdomäne der URL. In der untenstehenden Tabelle sehen Sie Beispiele dafür, was Sie mit Variablen tun können und was nicht:
Gültige Konfiguration Ungültige Konfiguration https://myshopify.com/admin/api/orders/order_number.jsonEine Bestellung anhand der Bestellnummer aus Shopify abrufen.
https://domain.com/api/search?input=valueVariablen können nicht zur Domäne/Subdomäne hinzugefügt werden
https://maps.googleapis.com/maps/api/place?input=city_nameEinen Ort per Schlüsselwortsuche aus der Google Places API abrufen.
https://example.com/api/search?key=valueVariablen können nicht zum Query-Stringschlüssel hinzugefügt werden.
Wenn eine Variable ungültig wird (z. B. weil das API-Schema geändert wurde), überspringt der Bot die Variable und zeigt sie dem Endbenutzer nicht an. Im Schritt API-Aufruf durchführen können Sie bis zu acht Variablen erstellen.
Nachdem Sie die API-Details konfiguriert und den API-Aufruf getestet haben, können Sie die in der API-Antwort zurückgegebenen Daten verwenden, um Ihre Variablen zu erstellen. Die folgenden Schritte sind eine Fortsetzung des im vorherigen Abschnitt beschriebenen Verfahrens.
So erstellen Sie eine Variable anhand der Antwortdaten
- Klicken Sie im Konfigurationsfenster auf API-Aufruf durchführen.
- Erweitern Sie das Akkordeon und identifizieren Sie die Daten aus dem externen System, die Sie in eine Variable umwandeln möchten.Tipp: Die vom externen System zurückgegebene Rohdatenantwort können Sie in der Registerkarte „Antworttext“ einsehen.
- Klicken Sie auf Speichern.
- Legen Sie einen Namen für die neue Variable fest. Variablennamen dürfen nur Kleinbuchstaben, Ziffern und Unterstriche enthalten.
Authentifizieren des API-Aufrufs
Im Schritt API-Aufruf durchführen können Sie zur Authentifizierung von API-Aufrufen eine Verbindung zu einem externen Dienst oder System herstellen.
Dazu müssen Sie zunächst die Verbindung im Admin Center erstellen. Mit einer Verbindung können Sie Anmeldedaten für den Dienst sicher speichern und weitergeben. Weitere Informationen und detaillierte Anweisungen finden Sie unter Erstellen von Verbindungen im Admin CenterWenn Sie Probleme haben, die Verbindung hinzuzufügen, schlagen Sie im Audit-Protokoll im Admin Center nach.
Überblick über die Schrittverzweigungen
Der Schritt API-Aufruf durchführen ist ein Verzweigungsschritt. Die weiteren Antworten des Bots hängen davon ab, ob die API erfolgreich ausgeführt wurde.
Dabei bewirken alle 200er-Antwortcodes, dass der Bot der Verzweigung „Erfolgreich“ folgt, und alle 400er- und 500er-Antwortcodes, dass er der Verzweigung „Fehlgeschlagen“ folgt. Wenn die API einen 200er-Antwortcode mit einer leeren Antwort zurückgibt. werden die in diesem Schritt gespeicherte Variablen zur Laufzeit übersprungen.
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.