zum Hauptinhalt springen
Dokumentation durchsuchen

Widget-Konfiguration

Konfigurieren Sie das Widget mit data-*-Attributen am Script-Tag.

Sie konfigurieren das Widget mit data-*-Attributen am Script-Tag. Hier ist der vollständige Satz.

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_test_..."
  data-position="bottom-left"
  data-env="development"
  data-chat-size="large"
  data-locale="fr"
  data-config-load="eager"
></script>
Ein vollständiges Beispiel: Entwicklungsschlüssel, Launcher unten links, großes Panel, französische Oberfläche, Konfiguration sofort geladen.

Kernattribute

  • data-key — Ihr veröffentlichbarer Schlüssel (pk_test_… oder pk_live_…). Erforderlich.
  • data-enabled — auf false setzen, um das Skript zu laden, das Widget aber nicht einzuhängen (standardmäßig true).
  • data-position — Ecke des Starters: bottom-right (Standard), bottom-left, top-right oder top-left.
  • data-locale — legt Sprache und Schreibrichtung für diese Seite fest (zum Beispiel ar oder en-US). Ohne dieses Attribut folgt das Widget automatisch der Sprache Ihrer Seite.
  • data-chat-size — small (Standard), medium, large, fullscreen oder embedded.
  • data-chat-mode — normal (Standard) oder split (ein zweispaltiges Layout).
  • data-env — development oder production (sonst aus dem Schlüsselpräfix abgeleitet).
  • data-theme — eine JSON-Zeichenkette mit Theme-Token-Überschreibungen.

Das Widget folgt der Sprache Ihrer Seite von selbst — ein Attribut ist nicht nötig. Es liest Ihr <html lang> und verlässt sich auf das, was auf dem Bildschirm steht, wenn Ihre Seite eine andere Schrift darstellt als sie angibt. Nutzen Sie Ihren eigenen Sprachumschalter, und der Chat folgt clientseitig, ohne Neuladen und ohne die Unterhaltung zu verlieren. Setzen Sie data-locale nur, wenn Sie das für eine Seite überschreiben möchten.

Die erste Nachricht Ihrer Besucherin oder Ihres Besuchers legt die Sprache der Unterhaltung fest, und dabei bleibt es auch, wenn danach die Sprache Ihrer Website gewechselt wird: Eine auf Hebräisch begonnene Unterhaltung antwortet weiter auf Hebräisch. Die Beschriftungen des Widgets und der KI-Hinweis folgen weiterhin Ihrer Seite, sodass der Hinweis immer in der gerade genutzten Sprache lesbar bleibt. Wer die Sprache wechseln möchte, sagt es einfach im Chat.

Erweiterte Attribute

  • data-origin — der Ursprung der Syncanix-API (standardmäßig die Produktions-API).
  • data-theme-name — wählt ein benanntes Design aus Ihrer Bibliothek; auto folgt der Hell/Dunkel-Einstellung der Host-Seite.
  • data-prompt-profile — führt auf dieser Seite ein bestimmtes Prompt-Profil aus, unter dem Namen, unter dem Sie es veröffentlicht haben. Nur veröffentlichte Profile sind benennbar; alles andere fällt auf Ihr aktives Profil zurück.
  • data-mount-target — ein CSS-Selektor, wohin ein eingebettetes Widget eingehängt wird.
  • data-split-page — die URL der Seite, die im split-Modus neben dem Chat angezeigt wird.
  • data-config-load — lazy (Einstellungen beim ersten Öffnen laden, Standard) oder eager (beim Einbinden).
  • data-executor — der Name einer globalen Funktion, die Browser-/Host-Aktionen ausführt.
  • data-token-provider — der Name einer globalen Funktion, die das Token des Endnutzers zurückgibt.
  • data-step-up-provider — der Name einer globalen Funktion, die die erhöhte Neuauthentifizierung auslöst.
  • data-headers-provider — der Name einer globalen Funktion, die zusätzliche Anfrage-Header zurückgibt.
  • data-client-witness — die passive, nur formbezogene Beobachtung des API-Verkehrs aktivieren (standardmäßig aus).
  • data-act-on-behalf-consent — eine einmalige Zustimmung „in Ihrem Namen handeln“ verlangen (standardmäßig aus).

Nächste Schritte