Integratiegids voor ontwikkelaars
Ontwikkelaarsoverzicht
WebChatAgent biedt drie manieren om een Chatbot aan je gebruikers te tonen. Kies een optie op basis van hoeveel controle je wilt over de interface.
| Integratie | Wat je krijgt | Het meest geschikt 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 |
| JavaScript SDK | Getypeerd npm-pakket voor de REST en WebSocket API | Aangepaste chat-UI's in JavaScript of TypeScript |
| Webhook | Nieuwe leads en afspraken als ondertekend JSON-verzoek naar je server | CRM-koppeling, automatiseringen |
Alle opties 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 configureer je in het dashboard en worden automatisch toegepast. Dit is de juiste keuze voor 90% van de websites.
- Handleiding voor Widget Embed, Script-tag, aangepast element, alle HTML-attributen, Eigen CSS, inline-modus en gebruik met SPA's
REST API
Wanneer je een eigen chat-interface nodig hebt, zoals een mobiele app, een aangepast webcomponent of een backend-automatisering, roep je het chat-eindpunt rechtstreeks aan. Je verstuurt een message samen met je chatbotId en ontvangt een door AI gegenereerd reply inclusief de bronnen. Een Sessie-ID in een response-header zorgt voor samenhang in gesprekken met meerdere berichten.
- REST API-referentie, Eindpunten, domein-authenticatie, request- en response-velden, foutcodes en codevoorbeelden in cURL, JavaScript, Python en PHP
JavaScript SDK
Bouw je een aangepaste chat-UI in JavaScript of TypeScript? Het webchatagent npm-pakket bundelt de REST en WebSocket API: streaming-antwoorden, bestanden Uploaden, feedback, lead-formulieren en Live chat met je team, met volledige TypeScript-types en zonder externe afhankelijkheden.
- JavaScript SDK: installatie, eerste Bericht, streaming, overdracht naar menselijke medewerkers. Pakket op npm, broncode op GitHub
WebSocket API
Voor Live chat, waarbij Berichten direct moeten aankomen en je typindicatoren, aanwezigheid en automatische Vertaling wilt gebruiken. Dezelfde socket ondersteunt zowel bezoekerswidgets als het dashboard voor medewerkers. Gebruik dit om een aangepaste agent-console te bouwen of om Live chat vanuit je eigen backend aan te sturen.
- WebSocket API-referentie, Verbinding, rollen, de events die je verstuurt en ontvangt, en een werkend client-voorbeeld
Welke moet ik kiezen?
| Use case | Aanbevolen |
|---|---|
| Een Chatbot toevoegen aan een website | Widget Embed |
| De chat binnen je eigen paginalay-out weergeven | Inlinechat (widget embed) |
| Aangepaste chat-UI in JavaScript of TypeScript | JavaScript SDK |
| Aangepaste chat-UI of mobiele app | REST API |
| Server-to-server automatisering (geen UI) | REST API |
| Realtime Live chat-dashboard voor menselijke medewerkers | WebSocket API |
Bekijk Use Cases voor concrete scenario's die deze integraties mogelijk maken.
