aller au contenu principal
Parcourir la documentation

Configuration du widget

Configurez le widget avec des attributs data-* sur la balise de script.

Vous configurez le widget avec des attributs data-* sur la balise de script. Voici l’ensemble complet.

<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>
Un exemple complet : clé de développement, lanceur en bas à gauche, grand panneau, interface en français, configuration chargée immédiatement.

Attributs principaux

  • data-key — votre clé publiable (pk_test_… ou pk_live_…). Obligatoire.
  • data-enabled — mettez false pour charger le script sans monter le widget (true par défaut).
  • data-position — coin du lanceur : bottom-right (par défaut), bottom-left, top-right ou top-left.
  • data-locale — fixe la langue et la direction pour cette page (par exemple ar ou en-US). Sans cet attribut, le widget suit automatiquement la langue de votre page.
  • data-chat-size — small (par défaut), medium, large, fullscreen ou embedded.
  • data-chat-mode — normal (par défaut) ou split (une disposition à deux volets).
  • data-env — development ou production (sinon déduit du préfixe de la clé).
  • data-theme — une chaîne JSON de surcharges de tokens de thème.

Le widget suit la langue de votre page tout seul : aucun attribut n'est nécessaire. Il lit votre <html lang> et, lorsque votre page affiche une écriture différente de celle qu'elle déclare, il se fie à ce qui est à l'écran. Utilisez votre propre sélecteur de langue et le chat suit, côté client, sans rechargement et sans perdre la conversation. N'utilisez data-locale que pour passer outre sur une page donnée.

Le premier message de votre visiteur fixe la langue de la conversation, et elle y reste même s'il change ensuite la langue de votre site : une conversation entamée en hébreu continue de répondre en hébreu. Les libellés du widget et l'avis IA suivent toujours votre page, si bien que l'avis reste lisible dans la langue qu'il consulte. S'il veut changer de langue, il lui suffit de le demander dans le chat.

Attributs avancés

  • data-origin — l’origine de l’API Syncanix (par défaut, l’API de production).
  • data-theme-name — sélectionne un design nommé de votre bibliothèque ; auto suit le réglage clair/sombre du site hôte.
  • data-prompt-profile — exécute sur cette page un profil de prompt précis, par le nom sous lequel vous l’avez publié. Seuls les profils publiés peuvent être nommés ; toute autre valeur retombe sur votre profil en service.
  • data-mount-target — un sélecteur CSS indiquant où monter un widget intégré.
  • data-split-page — l’URL de la page à afficher à côté du chat en mode split.
  • data-config-load — lazy (charger les réglages à la première ouverture, par défaut) ou eager (au montage).
  • data-executor — le nom d’une fonction globale qui exécute des actions du navigateur ou de l’hôte.
  • data-token-provider — le nom d’une fonction globale renvoyant le jeton de l’utilisateur final.
  • data-step-up-provider — le nom d’une fonction globale qui déclenche la réauthentification renforcée.
  • data-headers-provider — le nom d’une fonction globale renvoyant des en-têtes de requête supplémentaires.
  • data-client-witness — activez l’observation passive du trafic de l’API, sur sa forme uniquement (désactivé par défaut).
  • data-act-on-behalf-consent — exigez un consentement unique « agir en votre nom » (désactivé par défaut).

Étapes suivantes