Dokumentation
Das Widget einbinden
Ein einziges Skriptelement vor dem schließenden body-Element. Keine Abhängigkeiten, nichts von Servern anderer Firmen, keine Änderungen an Ihrem Code.
Der Ausschnitt
Den Schlüssel Ihrer Organisation finden Sie im Kundenbereich. Er ist bewusst öffentlich und steht im Quelltext Ihrer Seite.
<script src="https://aivatary.com/assets/caip-widget.js"
data-tenant-key="pw_0123456789abcdef"
data-api-base="https://app.aivatary.com"
defer></script>Warum der Schlüssel öffentlich sein darf
Der Schlüssel der Organisation ist kein Geheimnis. Das Widget tauscht ihn gegen ein kurzlebiges Sitzungstoken, und der Zugang ist zusätzlich durch die Liste erlaubter Domains begrenzt. Kein Geheimnis erreicht jemals den Browser, deshalb bringt es nichts, den Ausschnitt auf eine fremde Seite zu kopieren.
Optionale Attribute
| Attribut | Standard | Bedeutung |
|---|---|---|
| data-tenant-key | erforderlich | Der öffentliche Schlüssel Ihrer Organisation |
| data-api-base | erforderlich | Die Adresse, unter der die Plattform läuft |
| data-theme-attr | data-theme | Name des Attributs am html-Element, aus dem das Thema gelesen wird |
| data-locale | Sprache der Seite, dann pl | Sprache der Sitzung: pl oder en |
| data-auto-open | desktop | Automatisches Öffnen des Fensters: desktop für Fenster ab 900 Pixeln, always, never |
| data-avatar-selector | [data-caip-avatar] | Selektor des Containers, den der Avatar im Hero-Modus einnehmen soll |
Thema
- Wie es gelesen wird
- Das Widget schaut auf das Attribut, das data-theme-attr am html-Element benennt. Der Wert light bedeutet helles Thema, jeder andere Wert und ein fehlendes Attribut bedeuten dunkel.
- Ohne Neuladen
- Ein Wechsel des Themas auf Ihrer Seite wirkt sofort, weil das Widget die Änderung des Attributs verfolgt.
- Einstellung des Systems
- Das Widget liest die helle und dunkle Einstellung des Betriebssystems bewusst nicht, genau wie diese Website. Es entscheidet Ihr Attribut, damit das Widget nie vom Rest der Seite abweicht.
Die Liste erlaubter Domains
- Wo Sie sie setzen
- In den Einstellungen der Organisation, ein Eintrag je Domain, auf der das Widget antworten soll.
- Was außerhalb der Liste geschieht
- Eine Anfrage von einer Domain außerhalb der Liste wird nicht bedient. Genau deshalb muss der öffentliche Schlüssel kein Geheimnis sein.
- Testumgebung
- Eine Domain für Tests tragen Sie gesondert ein. Eine lokale Adresse ist ebenfalls eine Domain.
Das Widget erscheint nicht
Steht die Domain auf der Liste erlaubter Domains?
Die häufigste Ursache. Prüfen Sie, ob genau die Domain eingetragen ist, von der Sie die Seite öffnen, samt einem etwaigen www davor.
Wurde das Skript geladen?
Im Netzwerkbereich der Browserwerkzeuge sollte die Datei des Widgets zu sehen sein. Eine Blockade durch eine Erweiterung zum Blockieren von Werbung ist die zweithäufigste Ursache.
Stimmt der Schlüssel?
Der Schlüssel beginnt mit dem Präfix pw_ und stammt aus dem Kundenbereich Ihrer Organisation. Ein Schlüssel aus einer anderen Umgebung funktioniert nicht.
Lädt die Seite das Widget zweimal?
Das Widget schützt sich gegen doppeltes Laden, aber zwei verschiedene Schlüssel auf einer Seite sind ein Konflikt der Konfiguration und kein Fall, den man abfangen müsste.
Verdeckt etwas das Widget?
Ein Element mit sehr hohem Stapelwert kann es verbergen. Das Widget zeichnet in einem eigenen Baum, mit Ihrem Stylesheet lässt sich das also nicht beheben: die Ebene des verdeckenden Elements muss herunter.
Als Nächstes: der Avatar in der Seite
Wenn das Gespräch dort beginnen soll, wo die Figur steht, und nicht in einer Blase in der Ecke, gehen Sie weiter zum Hero-Modus.