Aangepaste API-integraties

Integreer je chatbot met aangepaste API's

Met behulp van onze AI actions-editor kun je elke gewenste aangepaste integratie bouwen met elk back-endsysteem dat gegevens via API-endpoints beschikbaar kan stellen. Je kunt de chatbot bijvoorbeeld laten controleren of een product op voorraad is in je magazijn, wat de status van een bestelling in je ERP-systeem is of wat het actuele saldo op de klantaccount is.

Je kunt ook acties uitvoeren om externe systemen bij te werken - bijvoorbeeld endpoints aanroepen die afspraken inplannen of webhooks activeren.

Vereisten

ℹ️ Controleer voordat je begint of je een ChatLab-abonnement hebt dat integraties met Custom API ondersteunt. Bekijk de prijzenpagina

Een Custom API toevoegen aan je chatbot

Door een aangepaste API te integreren, kan je chatbot communiceren met externe diensten - zoals je eigen webwinkel, om gegevens op te halen of acties uit te voeren namens de gebruiker.

Deze handleiding leidt je door de stappen die nodig zijn om een aangepaste API in te stellen via het ChatLab-platform.

Je API

Je moet beschikken over openbaar toegankelijke API-endpoints die door de chatbot kunnen worden aangeroepen. Dit betekent dat je gegevens uit je e-commerceplatform of je eigen systeem via API-endpoints beschikbaar moet stellen, zodat onze chatbot deze endpoints kan aanroepen om gegevens op te halen en aan je gebruikers te tonen.

API-aanroep door de chatbot

De API wordt tijdens interacties met gebruikers dynamisch door de chatbot aangeroepen wanneer de chatbot externe gegevens nodig heeft of specifieke acties moet uitvoeren. Houd hierbij rekening met het volgende:

• Geen gegarandeerde aanroep: De API wordt alleen aangeroepen wanneer de logica van de chatbot bepaalt dat dit noodzakelijk is. Er zijn geen garanties over wanneer of hoe vaak de API wordt aangeroepen.

• Vereisten voor het AI-model: Voor optimale prestaties raden we aan om geavanceerdere AI-modellen te gebruiken die complexe function calling ondersteunen, zoals GPT-4o of hoger. Deze modellen kunnen beter bepalen wat het juiste moment is om de API aan te roepen op basis van de context van het gesprek en de intentie van de gebruiker.

• Contextbewuste aanroepen: De chatbot probeert de API aan te roepen zodra deze een context in het gesprek herkent die aansluit bij het doel van de API. De uiteindelijke aanroep hangt echter af van meerdere factoren, zoals:

  • Beschikbaarheid en reactiesnelheid van de externe API.
  • De actuele status van het gesprek en de prompts van de gebruiker.
  • Interne betrouwbaarheidsscores en scoringsalgoritmen van het AI-model bij het bepalen van de noodzaak van de aanroep.

Stappen om een Custom API in te stellen

Stap 1: Navigeer naar de instellingen voor Custom API

1. Log in op je ChatLab-dashboard.

2. Klik in de zijbalk aan de linkerkant onder het gedeelte Settings (Instellingen) op Custom API (Aangepaste API).

Stap 2: Definieer een nieuwe API

1. Klik op de knop + Define API (API definiëren).

2. Voer een naam voor je API in het veld API Name (API-naam) in.

3. Vul in het veld URL de basis-URL in van de externe dienst waarmee je verbinding wilt maken.

4. Klik op Save (Opslaan) om de API aan te maken.

Stap 3: API-bewerkingen toevoegen

1. Klik bij het zojuist aangemaakte item onder API op de knop View (Weergeven).

2. Klik op + Define API Operation (API-bewerking definiëren) om afzonderlijke bewerkingen (endpoints) voor de API in te stellen.

3. Vul de vereiste gegevens in:

• Operation Name: Een beschrijvende naam voor de bewerking.
• Operation URI: Het pad van het endpoint voor de bewerking (bijv. /v1/resource).

Stap 4: Endpoint-URI en parameters configureren

1. Configuratie van de endpoint-URI:

• Voeg eventuele padvariabelen toe die nodig zijn voor de bewerking door te klikken op + Add path variable (Padvariabele toevoegen).
• Voer de gegevens van de variabele in en markeer deze indien nodig als verplicht.

• Kies de bron van de waarde:
  • Provided by user to chatbot - wanneer een waarde van de gebruiker nodig is om dit in te vullen.
  • Constant - wanneer dit een vaste waarde is die je moet opgeven op het moment dat je de API-bewerking definieert.
• Voeg de zojuist toegevoegde padvariabele toe aan de paddefinitie tussen twee "@"-tekens: @myvariable@:

1. Queryparameters:

• Voeg queryparameters toe door te klikken op + Add query parameter (Queryparameter toevoegen).
• Bepaal de parameternaam, het gegevenstype en de bron (bijv. opgegeven door de gebruiker of de chatbot).

Stap 5: De requestmethode en de body instellen

1. Kies de HTTP-methode voor de bewerking (bijv. GET, POST).

2. Configureer de request body als de requestmethode POST is:

• Kies het contenttype (bijv. application/json).
• Voeg de bodyparameters toe en geef de naam, het gegevenstype en de bron op.

• Voeg de variabelen toe aan de bodydefinitie - dit is meestal JSON waarin je de gedefinieerde variabelen kunt plaatsen.

Stap 6: Headers voor de bewerking instellen

Voeg headers toe - zoals Authorization of andere headers die je API nodig heeft. Bekijk de onderstaande schermafbeelding voor het instellen van een permanent token in de Authorization-header:

Stap 7: De bewerking opslaan

1. Controleer de configuratie om te controleren of alle gegevens juist zijn.

2. Klik op Save changes (Wijzigingen opslaan) om de API-bewerking op te slaan.

Stap 8: De API-integratie testen

1. Gebruik de functie Test API (API testen) om een testverzoek te verzenden en te controleren of de integratie correct werkt.

2. Controleer de logs op eventuele fouten of problemen en pas de configuratie zo nodig aan.

Stap 9: De API-bewerkingen koppelen aan de chatbot

Zodra de API Operations zijn gedefinieerd, kun je ze toewijzen aan de chatbot. Selecteer de chatbot in het hoofddashboard voor chatbots, klik op Integrations (Integraties) en selecteer AI API Actions in het linkermenu.

Klik op Attach (Koppelen) bij de gewenste API-bewerking.

Stap 10: Rolinstructies toevoegen voor de chatbot

Selecteer je chatbot in het hoofddashboard voor chatbots, klik op Settings en selecteer in het linkermenu Role (Rol).

Klik op Provide custom role instructions (Aangepaste rolinstructies opgeven).

Voeg instructies toe over het gebruik van de nieuw toegevoegde API-bewerking. Je kunt bijvoorbeeld een regel toevoegen zoals:

“- When user asks for store inventory always call getItems function and render the result of the function with following rules…..”

Tips voor een succesvolle integratie

• Zorg ervoor dat de basis-URL en endpoints correct en bereikbaar zijn.

• Controleer of alle verificatievereisten (zoals API-sleutels of tokens) goed zijn geconfigureerd.

• Test elke bewerking grondig om te controleren of deze de verwachte antwoorden retourneert.

Door deze stappen te volgen kun je naadloos aangepaste API's integreren in je ChatLab-chatbot, waardoor de functionaliteit wordt uitgebreid en je gebruikers een rijkere ervaring biedt.

Je Custom API-integratie beveiligen

Volg deze best practices om ervoor te zorgen dat je aangepaste API veilig is en beschermd blijft tegen ongeautoriseerde toegang:

Gebruik vaste tokens

Constante API-tokens: Stel een vast API-token (of vaste sleutel) in dat vereist is voor alle verzoeken aan de API. Dit token moet uniek zijn en op een veilige manier worden gegenereerd.

• Implementatie: Neem het token op in de request-header of als queryparameter bij elke API-aanroep.

• Opslaglocatie: Sla het token veilig op in je ChatLab-instellingen als de vaste parameter van de bewerking.

Gebruik een login-endpoint voor tijdelijke tokens

Voeg een extra API-bewerking toe aan de API die een tijdelijk beveiligingstoken retourneert - zoals een login-endpoint voor je systeem.

Wanneer je deze API-bewerking definieert, moet je de inloggegevens voor je systeem invoeren als vaste parameters van de API-bewerking. Om ervoor te zorgen dat de chatbot het op deze manier verkregen token kan gebruiken, moet je het beveiligingstoken toevoegen aan de definities van andere API-bewerkingen en duidelijke promptinstructies toevoegen aan zowel de loginbewerking als de overige API-bewerkingen (bijvoorbeeld: "Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder").

Gevoelige informatie beheren via ChatLab

Om te voorkomen dat de chatbot gevoelige informatie toont, kunnen ChatLab-gebruikers de volgende maatregelen nemen:

Gebruik prompt engineering om het gedrag van de AI te sturen

• Geef duidelijke instructies in prompts: Geef bij het configureren van de chatbot expliciete instructies in de promptinstellingen om te voorkomen dat er gevoelige informatie wordt getoond. Bijvoorbeeld:

  • Voorbeeld van een prompt: "Do not display any personal, financial, or confidential information returned by an API call."
  • Gebruik van systeemberichten: Voeg aan het begin van het gesprek een systeembericht toe om het belang van gegevensprivacy te benadrukken (bijv. "Ensure all outputs exclude any sensitive information.").

• Werk prompts regelmatig bij: Pas de prompts aan op basis van feedback van gebruikers of gewijzigde eisen rondom gegevensgevoeligheid. Zo zorg je ervoor dat de AI altijd de meest recente richtlijnen voor de omgang met gevoelige gegevens volgt.

Ontwerp API-endpoints met ingebouwde verificatielogica

• Vereis gebruikersverificatie voor toegang tot gevoelige gegevens: Bouw verificatiecontroles in je API-endpoints in voordat er gevoelige gegevens worden geretourneerd. Bijvoorbeeld:

  • Verificatieparameters: Vraag gebruikers om bepaalde gegevens op te geven (zoals een e-mailadres, bestelnummer of een specifieke beveiligingsvraag) voordat de API gegevens over die gebruiker retourneert.
  • Multifactorverificatie: Voeg aanvullende parameters toe (bijv. besteldatum, bezorgadres of een geheime code) om de identiteit van de gebruiker te verifiëren en te controleren of deze bevoegd is om de gegevens in te zien.

• Stel fail-safe-antwoorden in: Zorg dat je API-logica algemene meldingen of foutmeldingen retourneert wanneer de vereiste verificatie ontbreekt of niet overeenkomt:

  • Voorbeeld: "Unable to retrieve order details. Please verify your email and order number."

Beperk de gegevensomvang in API-antwoorden

• Minimaliseer de blootstelling van gegevens: Stel API-antwoorden zo in dat ze alleen de gegevens bevatten die noodzakelijk zijn voor de werking van de chatbot. Zo verklein je het risico dat gevoelige gegevens per ongeluk worden getoond.
  • Voorbeeld: Retourneer niet het volledige gebruikersprofiel, maar alleen specifieke velden zoals de bestelstatus of een betalingsbevestiging die nodig zijn voor de taak van de chatbot.