Documentation
Intégrer le widget
Une seule balise de script avant la fermeture du corps de page. Aucune dépendance, rien de téléchargé sur les serveurs d'autres entreprises, aucune modification de votre code.
L'extrait de code
La clé de votre organisation se trouve dans l'espace client. Elle est publique par conception et figure dans le source de votre page.
<script src="https://aivatary.com/assets/caip-widget.js"
data-tenant-key="pw_0123456789abcdef"
data-api-base="https://app.aivatary.com"
defer></script>Pourquoi la clé peut être publique
La clé de l'organisation n'est pas un secret. Le widget l'échange contre un jeton de session de courte durée, et l'accès est encore limité par la liste des domaines autorisés. Aucun secret n'atteint jamais le navigateur : copier l'extrait sur la page de quelqu'un d'autre ne donne donc rien.
Attributs optionnels
| Attribut | Par défaut | Signification |
|---|---|---|
| data-tenant-key | obligatoire | La clé publique de votre organisation |
| data-api-base | obligatoire | L'adresse où tourne la plateforme |
| data-theme-attr | data-theme | Nom de l'attribut porté par l'élément html d'où le thème est lu |
| data-locale | langue de la page, puis pl | Langue de la session : pl ou en |
| data-auto-open | desktop | Ouverture automatique du panneau : desktop pour les fenêtres à partir de 900 pixels, always, never |
| data-avatar-selector | [data-caip-avatar] | Sélecteur du conteneur que l'avatar doit occuper en mode hero |
Thème
- Comment il est lu
- Le widget regarde l'attribut désigné par data-theme-attr sur l'élément html. La valeur light signifie thème clair ; toute autre valeur, ou l'absence d'attribut, signifie sombre.
- Aucun rechargement
- Un changement de thème sur votre page prend effet aussitôt, car le widget suit les modifications de l'attribut.
- Préférence du système
- Le widget ignore délibérément le réglage clair et sombre du système d'exploitation, exactement comme ce site. C'est votre attribut qui décide, pour que le widget ne s'écarte jamais du reste de la page.
La liste des domaines autorisés
- Où la régler
- Dans les réglages de l'organisation, une entrée par domaine sur lequel le widget doit répondre.
- Ce qui se passe hors liste
- Une requête venant d'un domaine absent de la liste n'est pas servie. C'est précisément pour cela que la clé publique n'a pas besoin d'être secrète.
- Environnement de test
- Un domaine de test doit être ajouté séparément. Une adresse locale est elle aussi un domaine.
Le widget n'apparaît pas
Le domaine figure-t-il sur la liste des domaines autorisés ?
La cause la plus fréquente. Vérifiez que le domaine saisi est exactement celui depuis lequel vous ouvrez la page, avec l'éventuel préfixe www.
Le script s'est-il chargé ?
L'onglet réseau des outils du navigateur doit montrer le fichier du widget. Le blocage par une extension de blocage de publicité est la deuxième cause la plus fréquente.
La clé est-elle correcte ?
La clé commence par le préfixe pw_ et provient de l'espace client de votre organisation. Une clé issue d'un autre environnement ne fonctionnera pas.
La page charge-t-elle le widget deux fois ?
Le widget se protège du double chargement, mais deux clés différentes sur une même page constituent un conflit de configuration, pas un cas à traiter.
Quelque chose recouvre-t-il le widget ?
Un élément doté d'une valeur d'empilement très élevée peut le masquer. Le widget se dessine dans son propre arbre : votre feuille de style n'y changera rien, il faut abaisser la couche de l'élément qui recouvre.
Ensuite : l'avatar dans la page
Si vous voulez que la conversation démarre là où se tient le personnage plutôt que dans une bulle au coin de l'écran, passez au mode hero.