API-connectors voor live chatbotgegevens
API Connectors
Met API Connectors kan uw chatbot tijdens een gesprek externe REST APIs aanroepen om realtime gegevens op te halen. Gebruik ze om bestellingen op te zoeken, de voorraad te controleren, accounts te verifiëren of gegevens op te halen uit elke gewenste service met een API. De chatbot verzamelt de benodigde gegevens bij de bezoeker, roept uw API aan, valideert de respons en presenteert het resultaat op een natuurlijke manier in het gesprek.
Een API-connector toevoegen
Open uw assistent in het dashboard, vouw Geavanceerde instellingen onder de hoofdtabbladen uit, selecteer API Connectors en klik op API-connector toevoegen. API-connectors zijn geen Kanaal of Functie. U kunt beginnen met een vooraf gebouwd sjabloon of zelf een aangepaste connector samenstellen.
Configuratievelden
Basisinstellingen
| Veld | Beschrijving | Verplicht |
|---|---|---|
| Naam | Een beschrijvende naam voor deze connector (bijvoorbeeld "Bestelling opzoeken", "Voorraad controleren"). | Ja |
| URL | De API-eindpunt-URL (bijvoorbeeld https://api.example.com/orders). | Ja |
| Methode | HTTP-methode: GET, POST, PUT, PATCH of DELETE. | Ja (standaard: GET) |
| Headers (JSON) | Optionele HTTP-headers in JSON-indeling (bijvoorbeeld {"Authorization": "Bearer abc123", "Content-Type": "application/json"}). Moet geldige JSON zijn. | Nee |
| Ingeschakeld | Geeft aan of deze connector actief is. | Ja (standaard: Aan) |
Request body (alleen POST/PUT/PATCH)
| Veld | Beschrijving |
|---|---|
| Body Content-type | Indeling van de request body: JSON of Form Data. |
| Request Body-sjabloon | Sjabloon voor de request body. Gebruik tijdelijke aanduidingen zoals {email}, {order_id} die overeenkomen met uw gedefinieerde velden. |
Voorbeeld van een body-sjabloon:
{
"email": "{email}",
"order_id": "{order_id}"
}
Velden
Velden bepalen welke informatie de chatbot bij de bezoeker moet verzamelen voordat de API wordt aangeroepen. Elk veld heeft:
| Eigenschap | Beschrijving | Verplicht |
|---|---|---|
| Veldnaam | De ID van het veld (bijvoorbeeld order_id, email). Wordt gebruikt als tijdelijke aanduiding in de request body. | Ja |
| Type | Gegevenstype: string, number, email of boolean. | Ja (standaard: string) |
| Beschrijving (voor AI) | Legt aan de AI uit waar dit veld voor dient en hoe dit aan de bezoeker gevraagd moet worden. | Nee |
| Verplicht | Geeft aan of de bezoeker dit veld moet invullen voordat de API wordt aangeroepen. | Nee |
Voorbeeldvelden:
| Naam | Type | Beschrijving | Verplicht |
|---|---|---|---|
order_id | string | Het bestelnummer van de klant, begint meestal met ORD- | Ja |
email | Het e-mailadres dat is gebruikt bij het plaatsen van de bestelling | Ja |
Responsvalidatieregels
Validatieregels controleren of de API-respons overeenkomt met de invoer van de bezoeker. Dit voorkomt dat er gegevens voor de verkeerde persoon of bestelling worden getoond.
Elke regel heeft:
| Eigenschap | Beschrijving |
|---|---|
| Invoerveld | Het door de bezoeker opgegeven veld waarmee gevalideerd moet worden (uit uw gedefinieerde velden). |
| Responspad | Pad naar de waarde in de API-respons (bijvoorbeeld billing.email, data.order.status). Gebruik puntnotatie voor geneste objecten. |
| Vergelijking | Wijze van vergelijken: equals, equals (ignore case), contains of not empty. |
| Foutmelding | Bericht dat aan de bezoeker wordt getoond wanneer de validatie mislukt (bijvoorbeeld "Het e-mailadres komt niet overeen met onze gegevens"). |
Voorbeeldvalidatie:
| Invoerveld | Responspad | Vergelijking | Foutmelding |
|---|---|---|---|
| billing.email | equals (ignore case) | Het e-mailadres komt niet overeen met de bestelling. Controleer het en probeer het opnieuw. |
Prompt
Instructies voor de AI over wanneer en hoe deze connector moet worden gebruikt. Dit is essentieel zodat de chatbot weet wanneer de API-aanroep moet worden geactiveerd.
Voorbeeldprompt:
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.
Hoe het werkt
- De bezoeker stelt een vraag die overeenkomt met de prompt van de connector (bijvoorbeeld "Waar is mijn bestelling?")
- De chatbot vraagt om de verplichte velden (bijvoorbeeld bestelnummer, e-mailadres)
- De bezoeker geeft de informatie door
- De chatbot roept de API aan met de verzamelde gegevens
- Validatieregels worden gecontroleerd aan de hand van de respons
- Als de validatie slaagt, presenteert de chatbot de gegevens in een natuurlijk gespreksformat
Meerdere API-connectors koppelen
U kunt meerdere API-connectors combineren om complexe workflows te verwerken. De AI koppelt ze automatisch aan elkaar wanneer dat nodig is.
Voorbeeld: Authenticatie + Gegevens ophalen
- Connector 1, "Klant authenticeren": Roept een login-eindpunt aan met het e-mailadres en wachtwoord van de bezoeker, en ontvangt een authenticatietoken in de respons.
- Connector 2, "Bestelgegevens ophalen": Gebruikt het token uit het eerste verzoek om een beveiligd API-eindpunt aan te roepen en bestelgegevens op te halen.
De AI regelt dit naadloos: het herkent dat de tweede connector gegevens van de eerste nodig heeft, voert de aanroepen in de juiste volgorde uit en presenteert het eindresultaat aan de bezoeker, allemaal binnen hetzelfde gesprek.
Configureer hiervoor elke connector afzonderlijk met een eigen eindpunt, velden en prompt. Geef in de prompt van de tweede connector aan dat deze afhankelijk is van gegevens uit de eerste (bijvoorbeeld "Gebruik het authenticatietoken van de connector Klant authenticeren om dit eindpunt aan te roepen"). De AI zal de volgorde automatisch beheren.
Best practices
- Schrijf duidelijke prompts: de prompt is het belangrijkste veld; deze bepaalt wanneer de connector wordt geactiveerd
- Voeg validatieregels toe: valideer gevoelige gegevens altijd om datalekken te voorkomen
- Gebruik duidelijke veldbeschrijvingen: help de AI om op een natuurlijke manier de juiste vragen te stellen
- Test met echte API-responsen: zorg dat het responspad overeenkomt met uw werkelijke API-structuur
- Handel fouten netjes af: stel duidelijke foutmeldingen in voor situaties waarin de validatie mislukt
- Gebruik authenticatie-headers: beveilig uw API-eindpunten altijd met de juiste authenticatie