API-Connectors für Live-Chatbot-Daten
API Connectors
Mit API Connectors kann Ihr Chatbot während eines Gesprächs externe REST-APIs aufrufen, um Daten in Echtzeit abzurufen. Nutzen Sie sie, um Bestellungen nachzuschlagen, Bestände zu prüfen, Konten zu verifizieren oder Daten von jedem Dienst abzurufen, der eine API bereitstellt. Der Chatbot erfragt die erforderlichen Details beim Besucher, ruft Ihre API auf, validiert die Antwort und präsentiert das Ergebnis in natürlicher Sprache.
API Connector hinzufügen
Öffnen Sie Ihren Assistenten im Dashboard, klappen Sie Experteneinstellungen unterhalb der Hauptreiter auf, wählen Sie API Connectors und klicken Sie auf API Connector hinzufügen. API Connectors sind weder ein Kanal noch eine Funktion. Sie können mit einer vorgefertigten Vorlage starten oder einen benutzerdefinierten Connector von Grund auf neu erstellen.
Konfigurationsfelder
Grundeinstellungen
| Field | Beschreibung | Pflichtfeld |
|---|---|---|
| Name | Ein aussagekräftiger Name für diesen Connector (z. B. "Bestellabfrage", "Bestandsprüfung"). | Ja |
| URL | Die API-Endpunkt URL (z. B. https://api.example.com/orders). | Ja |
| HTTP-Methode | HTTP-Methode: GET, POST, PUT, PATCH oder DELETE. | Ja (Standard: GET) |
| Headers (JSON) | Optionale HTTP-Header im JSON-Format (z. B. {"Authorization": "Bearer abc123", "Content-Type": "application/json"}). Muss gültiges JSON sein. | Nein |
| Aktiviert | Gibt an, ob dieser Connector aktiv ist. | Ja (Standard: Aktiviert) |
Request-Body (nur POST/PUT/PATCH)
| Field | Beschreibung |
|---|---|
| Body Content-Typ | Format des Request-Bodys: JSON oder Form Data. |
| Request Body-Vorlage | Vorlage für den Request-Body. Verwenden Sie Platzhalter wie {email}, {order_id}, die Ihren definierten Feldern entsprechen. |
Beispiel für eine Body-Vorlage:
{
"email": "{email}",
"order_id": "{order_id}"
}
Felder
Felder definieren, welche Informationen der Chatbot vom Besucher erfassen muss, bevor er die API aufruft. Jedes Feld enthält:
| Eigenschaft | Beschreibung | Pflichtfeld |
|---|---|---|
| Feldname | Die Feldkennung (z. B. order_id, email). Wird als Platzhalter im Request-Body verwendet. | Ja |
| Typ | Datentyp: string, number, email oder boolean. | Ja (Standard: string) |
| Beschreibung (für KI) | Erklärt der KI, wozu dieses Feld dient und wie sie den Besucher danach fragen soll. | Nein |
| Pflichtfeld | Gibt an, ob der Besucher dieses Feld ausfüllen muss, bevor die API aufgerufen wird. | Nein |
Beispielfelder:
| Name | Typ | Beschreibung | Pflichtfeld |
|---|---|---|---|
order_id | string | Die Bestellnummer des Kunden, beginnt üblicherweise mit ORD- | Ja |
email | Die bei der Bestellung verwendete E-Mail-Adresse | Ja |
Regeln für die Antwort-Validierung
Validierungsregeln stellen sicher, dass die API-Antwort mit den Angaben des Besuchers übereinstimmt. Dies verhindert, dass Daten für die falsche Person oder Bestellung ausgegeben werden.
Jede Regel enthält:
| Eigenschaft | Beschreibung |
|---|---|
| Eingabefeld | Das vom Besucher bereitgestellte Feld, gegen das validiert werden soll (aus Ihren definierten Feldern). |
| Antwort-Pfad | Pfad zum Wert in der API-Antwort (z. B. billing.email, data.order.status). Verwenden Sie die Punktnotation für verschachtelte Objekte. |
| Vergleich | Art des Abgleichs: equals, equals (ignore case), contains oder not empty. |
| Fehlermeldung | Nachricht, die dem Besucher angezeigt wird, wenn die Validierung fehlschlägt (z. B. "Die E-Mail stimmt nicht mit unseren Einträgen überein"). |
Beispielvalidierung:
| Eingabefeld | Antwort-Pfad | Vergleich | Fehlermeldung |
|---|---|---|---|
| billing.email | equals (ignore case) | Die E-Mail-Adresse stimmt nicht mit der Bestellung überein. Bitte überprüfen und erneut versuchen. |
Prompt
Anweisungen für die KI, wann und wie dieser Connector zu verwenden ist. Dies ist entscheidend, damit der Chatbot weiß, wann der API-Aufruf ausgelöst werden soll.
Beispiel-Prompt:
Use this connector when a customer asks about their order status, shipping
information, or delivery date. Ask for their order ID and email address before
making the API call. Present the order status, shipping method, and estimated
delivery date in a friendly format.
So funktioniert's
- Der Besucher stellt eine Frage, die zum Prompt des Connectors passt (z. B. "Wo ist meine Bestellung?")
- Der Chatbot fragt nach den erforderlichen Pflichtfeldern (z. B. Bestellnummer, E-Mail)
- Der Besucher gibt die Informationen ein
- Der Chatbot ruft die API mit den erfassten Daten auf
- Die Validierungsregeln werden anhand der Antwort geprüft
- Ist die Validierung erfolgreich, gibt der Chatbot die Daten in natürlicher Sprache aus
Mehrere API Connectors verketten
Sie können mehrere API Connectors kombinieren, um komplexe Workflows abzubilden. Die KI verkettet diese bei Bedarf automatisch.
Beispiel: Authentifizierung + Datenabruf
- Connector 1: "Kunden authentifizieren": Ruft einen Login-Endpunkt mit der E-Mail-Adresse und dem Passwort des Besuchers auf und erhält ein Authentifizierungs-Token in der Antwort.
- Connector 2: "Bestelldetails abrufen": Verwendet das Token aus der ersten Anfrage, um einen geschützten API-Endpunkt aufzurufen und Bestelldaten abzurufen.
Die KI wickelt dies nahtlos ab: Sie erkennt, dass der zweite Connector Daten aus dem ersten benötigt, führt die Aufrufe in der richtigen Reihenfolge aus und präsentiert dem Besucher das Endergebnis, alles innerhalb eines einzigen Gesprächsverlaufs.
Um dies einzurichten, konfigurieren Sie jeden Connector separat mit eigenem Endpunkt, Feldern und Prompt. Beschreiben Sie im Prompt des zweiten Connectors, dass er von Daten des ersten abhängt (z. B. "Verwende das Authentifizierungs-Token aus dem Connector 'Kunden authentifizieren', um diesen Endpunkt aufzurufen"). Die KI steuert den Ablauf automatisch.
Best Practices
- Klare Prompts verfassen: Der Prompt ist das wichtigste Feld; er bestimmt, wann der Connector ausgelöst wird
- Validierungsregeln hinzufügen: Validieren Sie vertrauliche Daten immer, um Datenlecks zu vermeiden
- Aussagekräftige Feldbeschreibungen nutzen: Helfen Sie der KI, die richtigen Fragen auf natürliche Weise zu stellen
- Mit echten API-Antworten testen: Stellen Sie sicher, dass der Antwort-Pfad mit Ihrer tatsächlichen API-Struktur übereinstimmt
- Fehler sauber abfangen: Hinterlegen Sie verständliche Fehlermeldungen für fehlgeschlagene Validierungen
- Authentifizierungs-Header verwenden: Sichern Sie Ihre API-Endpunkte stets mit einer geeigneten Authentifizierung ab