Entwickler-Integrationsleitfaden

Entwickler-Übersicht

WebChatAgent bietet Ihnen drei Möglichkeiten, einen Chatbot für Ihre Benutzer bereitzustellen. Wählen Sie die passende Option basierend darauf, wie viel Kontrolle Sie über die Oberfläche benötigen.

IntegrationWas Sie erhaltenAm besten für
Widget-EinbindungEine fertige Chat-UI über ein einzelnes Script-TagWebsites und Web-Apps
REST APISenden Sie eine Nachricht, erhalten Sie eine Antwort (Request/Response)Eigene Benutzeroberflächen, mobile Apps, Server-Skripte
WebSocket APIEchtzeit-Nachrichten-Stream mit Tippanzeige und AnwesenheitsstatusLive-Chat-Dashboards, Agenten-Tools
JavaScript SDKTypisiertes npm-Paket für die REST und WebSocket APIEigene Chat-UIs in JavaScript oder TypeScript
WebhookNeue Leads und Termine als signierte JSON-Anfrage an Ihren ServerCRM-Anbindung, Automationen

Alle drei greifen auf denselben Chatbot zu, teilen dieselbe Wissensdatenbank und werden auf dasselbe Nachrichtenkontingent angerechnet. Sie können die Optionen kombinieren, zum Beispiel indem Sie das Widget auf Ihrer Website einbinden und ein internes Agenten-Dashboard über die WebSocket API erstellen.

Widget-Einbindung (am schnellsten)

Fügen Sie den Chatbot mit einem einzigen Script-Tag und einem benutzerdefinierten HTML-Element (<web-chat-agent chatbot-id="...">) zu jeder Website hinzu. Kein Framework, kein Build-Schritt erforderlich. Alle Farben, Texte und Tools werden im Dashboard konfiguriert und automatisch angewendet. Dies ist die richtige Wahl für 90 % aller Websites.

REST API

Wenn Sie eine eigene Chat-Oberfläche benötigen, etwa eine mobile App, eine benutzerdefinierte Webkomponente oder eine Backend-Automatisierung, rufen Sie den Chat-Endpunkt direkt auf. Sie senden eine message zusammen mit Ihrer chatbotId und erhalten eine KI-generierte reply mit ihren Quellen. Eine Sitzungs-ID im Response-Header sorgt dafür, dass Konversationen über mehrere Abschnitte hinweg konsistent bleiben.

  • REST-API-Referenz, Endpunkte, Domain-Authentifizierung, Request/Response-Felder, Fehlercodes sowie Codebeispiele in cURL, JavaScript, Python und PHP

JavaScript SDK

Erstellen Sie eine eigene Chat-UI in JavaScript oder TypeScript? Das npm-Paket webchatagent kapselt die REST und WebSocket API: Streaming-Antworten, Datei-Upload, Feedback, Lead-Formulare und Live-Chat mit Ihrem Team, mit vollständigen TypeScript-Typen und ohne Abhängigkeiten.

  • JavaScript SDK: Installation, erste Nachricht, Streaming, Übergabe an Agenten. Paket auf npm, Quellcode auf GitHub

WebSocket API

Für Live-Chat, bei dem Nachrichten sofort ankommen müssen und Sie Tippanzeigen, Anwesenheitsstatus sowie automatische Übersetzung benötigen. Derselbe Socket steuert die Besucher-Widgets und das Agenten-Dashboard. Nutzen Sie ihn, um eine eigene Agentenkonsole zu bauen oder Live-Chat über Ihr eigenes Backend zu betreiben.

  • WebSocket-API-Referenz, Verbindung, Rollen, die gesendeten und empfangenen Events sowie ein funktionierendes Client-Beispiel

Was sollte ich verwenden?

AnwendungsfallEmpfohlen
Chatbot zu einer Website hinzufügenWidget-Einbindung
Chat innerhalb des eigenen Seitenlayouts darstellenInline-Chat (Widget-Einbindung)
Eigene Chat-UI in JavaScript oder TypeScriptJavaScript SDK
Eigene Chat-UI oder mobile AppREST API
Server-zu-Server-Automatisierung (ohne UI)REST API
Echtzeit-Live-Chat-Dashboard für menschliche AgentenWebSocket API

Unter Anwendungsfälle finden Sie konkrete Szenarien, die diese Integrationen ermöglichen.