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.

IntegratieWat je krijgtHet meest geschikt voor
Widget EmbedEen kant-en-klare chat-UI via één script-tagWebsites en web-apps
REST APIVerstuur een Bericht, ontvang een Antwoord (request/response)Aangepaste UI's, mobiele apps, server-scripts
WebSocket APIRealtime berichtenstroom met typindicatoren en aanwezigheidLive chat-dashboards, agent-tools
JavaScript SDKGetypeerd npm-pakket voor de REST en WebSocket APIAangepaste chat-UI's in JavaScript of TypeScript
WebhookNieuwe leads en afspraken als ondertekend JSON-verzoek naar je serverCRM-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.

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.

Welke moet ik kiezen?

Use caseAanbevolen
Een Chatbot toevoegen aan een websiteWidget Embed
De chat binnen je eigen paginalay-out weergevenInlinechat (widget embed)
Aangepaste chat-UI in JavaScript of TypeScriptJavaScript SDK
Aangepaste chat-UI of mobiele appREST API
Server-to-server automatisering (geen UI)REST API
Realtime Live chat-dashboard voor menselijke medewerkersWebSocket API

Bekijk Use Cases voor concrete scenario's die deze integraties mogelijk maken.