zum Hauptinhalt springen
Dokumentation durchsuchen

Laufzeit-API des Widgets

Steuern Sie das Widget aus JavaScript über das window.syncanix-Objekt.

Sobald das Widget geladen ist, installiert es ein window.syncanix-Objekt, das Sie aus Ihrem eigenen Code aufrufen können.

Was Sie tun können

  • open() — das Chat-Panel programmatisch öffnen.
  • setPosition(position) — den Starter in eine andere Ecke verschieben.
  • unmount() — das Widget von der Seite entfernen.
  • registerComponent() / unregisterComponent() / getComponentCatalog() — eigene React-Komponenten registrieren, die der Assistent darstellt, validiert über ein Schema.
  • setContext() / clearContext() — den Live-Zustand der App (Nutzer, Seite, Warenkorb) in den nächsten Zug einspeisen. Nur begrenztes JSON — niemals Geheimnisse.
  • setTokenProvider(fn) — das Token des Endnutzers je Zug bereitstellen (hat Vorrang vor dem data-Attribut).
  • setStepUpProvider(fn) — den Ablauf der erhöhten Neuauthentifizierung bereitstellen.

Beispiel

// Open the chat programmatically
window.syncanix.open();

// Feed live host-app context into the next turn (bounded JSON, no secrets)
window.syncanix.setContext({ page: 'checkout', cartItems: 3 });

// Provide the signed-in user's token per turn (recommended for SSR apps)
window.syncanix.setTokenProvider(async () => await getAccessToken());

Was der Assistent darstellen kann — und was er nicht sieht

Die darstellbare Oberfläche ist bewusst explizit: die eingebauten Primitiven, die Komponenten, die Sie mit registerComponent registrieren, und Embeds von Ursprüngen, die Ihr Administrator freigegeben hat. Der Assistent kann nur steuern, was Sie ihm gezielt übergeben haben.

Das Widget scannt, erkennt oder erfasst das DOM Ihrer Seite niemals automatisch in das Modell. Host-Seiteninhalte in einen KI-Kontext einzulesen ist eine Angriffsfläche für Datenabfluss und Injection — die Live-DOM-Erfassung bleibt deshalb kundengesteuert: Sie entscheiden durch Registrierung, was einbettbar ist.

Einmal geladen

Das Installieren des globalen Objekts ist idempotent — wird das Script zweimal eingebunden, wird das Duplikat mit einer Warnung ignoriert, sodass Sie nie zwei Widgets haben.

Nächste Schritte