Entwickler-Integrationsleitfaden
Developer Übersicht
WebChatAgent bietet drei Möglichkeiten, einen Chatbot für Ihre Benutzer bereitzustellen. Wählen Sie die passende Option basierend darauf, wie viel Kontrolle Sie über die Benutzeroberfläche benötigen.
| Integration | Was Sie erhalten | Am besten für |
|---|---|---|
| Widget Embed | Eine fertige Chat-UI über ein einzelnes Script-Tag | Websites und Web-Apps |
| REST API | Nachricht senden, Antwort erhalten (Request/Response) | Eigene UIs, mobile Apps, Server-Skripte |
| WebSocket API | Echtzeit-Nachrichten-Stream mit Tippanzeige und Status | Live-Chat Dashboards, Agenten-Tools |
Alle drei Optionen kommunizieren mit demselben Chatbot, nutzen dieselbe Wissensdatenbank und werden auf dasselbe Kontingent für Nachrichten angerechnet. Sie können sie kombinieren, zum Beispiel indem Sie das Widget auf Ihrer Website einbinden und ein internes Agenten-Dashboard über die WebSocket API erstellen.
Widget Embed (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. Alle Farben, Texte und Tools werden im Dashboard konfiguriert und automatisch angewendet. Dies ist für 90 % aller Websites die richtige Wahl.
- Widget Embed Guide, Script-Tag, benutzerdefiniertes Element, alle HTML-Attribute, Eigenes CSS, Inline-Modus und Nutzung in SPAs
REST API
Wenn Sie eine eigene Chat-Oberfläche benötigen, etwa eine mobile App, eine eigene 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 inklusive Quellen. Eine in einem Response-Header zurückgegebene Sitzungs-ID sorgt dafür, dass mehrstufige Konversationen zusammenhängend bleiben.
- REST API Reference, Endpunkte, Domain-Authentifizierung, Request-/Response-Felder, Fehlercodes und Codebeispiele in cURL, JavaScript, Python und PHP
WebSocket API
Für Live-Chat, bei dem Nachrichten sofort ankommen müssen und Sie Tippindikatoren, Anwesenheitsstatus sowie automatische Übersetzung benötigen. Derselbe Socket versorgt Besucher-Widgets und das Agenten-Dashboard. Nutzen Sie ihn, um eine eigene Agentenkonsole zu erstellen oder Live-Chat über Ihr eigenes Backend zu steuern.
- WebSocket API Reference, Verbindung, Rollen, gesendete und empfangene Events sowie ein funktionsfähiges Client-Beispiel
Welche Option sollte ich nutzen?
| Anwendungsfall | Empfohlen |
|---|---|
| Chatbot zu einer Website hinzufügen | Widget Embed |
| Chat innerhalb des eigenen Seitenlayouts darstellen | Inline-Chat (Widget Embed) |
| Eigene Chat-UI oder mobile App | REST API |
| Server-zu-Server-Automatisierung (ohne UI) | REST API |
| Echtzeit-Live-Chat-Dashboard für menschliche Agenten | WebSocket API |
Unter Use Cases finden Sie konkrete Szenarien, die diese Integrationen ermöglichen.