Integratiehandleiding voor ontwikkelaars
Developer Overzicht
WebChatAgent biedt drie manieren om een chatbot aan je gebruikers te tonen. Kies een optie op basis van de hoeveelheid controle die je nodig hebt over de interface.
| Integratie | Wat je krijgt | Het beste voor |
|---|---|---|
| Widget Embed | Een kant-en-klare chat-UI via één script-tag | Websites en web-apps |
| REST API | Verstuur een bericht, ontvang een antwoord (request/response) | Aangepaste UI's, mobiele apps, server-scripts |
| WebSocket API | Realtime berichtenstroom met typindicatoren en aanwezigheid | Live chat dashboards, agent-tools |
Alle drie communiceren met dezelfde chatbot, delen dezelfde Kennisbank en tellen mee voor hetzelfde berichtentotaal. Je kunt ze combineren, bijvoorbeeld door de widget op je site in te sluiten en een intern agent-dashboard te bouwen op de WebSocket API.
Widget Embed (Snelste)
Voeg de chatbot toe aan elke website met een enkele script-tag en een aangepast HTML-element (<web-chat-agent chatbot-id="...">). Geen framework, geen build-stap. Alle kleuren, teksten en tools worden geconfigureerd in het dashboard en automatisch toegepast. Dit is de juiste keuze voor 90% van de websites.
- Widget Embed Guide, Script-tag, aangepast element, alle HTML-attributen, Eigen CSS, inline-modus en SPA-gebruik
REST API
Wanneer je een eigen chatinterface nodig hebt, zoals een mobiele app, een aangepaste webcomponent of een backend-automatisering, roep je het chat-endpoint rechtstreeks aan. Je verstuurt een message samen met je chatbotId en ontvangt een door AI gegenereerd reply met de bijbehorende bronnen. Een Sessie-ID in een response-header zorgt ervoor dat gesprekken met meerdere beurten samenhangend blijven.
- REST API Reference, Endpoints, domein-authenticatie, request/response-velden, foutcodes en codevoorbeelden in cURL, JavaScript, Python en PHP
WebSocket API
Voor live chat, waarbij berichten direct moeten aankomen en je typindicatoren, aanwezigheid en automatische vertaling wilt tonen. Dezelfde socket drijft zowel bezoekerswidgets als het agent-dashboard aan. Gebruik het om een aangepaste agent-console te bouwen of om live chat vanuit je eigen backend aan te sturen.
- WebSocket API Reference, Verbinding, rollen, de events die je verzendt en ontvangt, en een werkend clientvoorbeeld
Welke moet ik gebruiken?
| Use-case | Aanbevolen |
|---|---|
| Voeg een chatbot toe aan een website | Widget Embed |
| Toon de chat binnen je eigen paginalay-out | Inlinechat (widget embed) |
| Aangepaste chat-UI of mobiele app | REST API |
| Server-to-server automatisering (geen UI) | REST API |
| Realtime live chat dashboard voor menselijke agents | WebSocket API |
Zie Use Cases voor concrete scenario's die deze integraties mogelijk maken.