Aller au contenu
KeuralDocs
Développeurs

Chatbot

Ajoutez un bouton de chatbot Keural au site de votre organisation avec un code d'installation.

Une organisation peut intégrer un chatbot Keural à son site web. Lorsqu'un visiteur clique sur le bouton situé dans un coin de l'écran, une fenêtre de chat s'ouvre. Collez sur votre site le code d'installation créé dans l'écran d'administration.

Créer un chatbot

  1. Un propriétaire ou un administrateur de l'organisation clique sur Ajouter un chatbot dans Gestion de l'organisation → Chatbots.
  2. Saisissez un nom de chatbot et un domaine de base (par exemple, https://example.com), puis enregistrez.
  3. Ouvrez le chatbot et configurez les trois onglets.
OngletParamètres
Jeton et installationVérifier le jeton et copier le code d'installation (HTML · Next.js)
Interface du chatbotImage du bouton (PNG, JPG, GIF, WebP) et affichage, nom du chatbot, affichage de l'en-tête, extension et couleur, couleur du bouton, position du bouton (gauche ou droite) et décalages horizontal et vertical. Vérifier dans l'aperçu
AvancéAdresses de pages où le chatbot peut s'ouvrir (domaines autorisés, 5 maximum)
  1. Collez le code d'installation dans votre site web.

Code d'installation

Dans l'onglet Jeton et installation, copiez le code HTML ou Next.js. Le code se compose de deux parties.

  • Chargeur : il crée la fonction Keural, puis, une fois la page entièrement chargée, charge de façon asynchrone le script du chatbot (/plugin/keural-widget@1.0.1.js). Les commandes appelées avant le chargement du script sont mises en file d'attente et exécutées dans l'ordre.
  • Commande de démarrage : Keural('boot', { token: '…' }). Le jeton commence par wgt_.

La version du script est fixée dans l'adresse. Lorsqu'une nouvelle version sort, copiez à nouveau le code d'installation et remplacez l'ancien. Si vous collez le code d'installation deux fois sur la même page, la seconde occurrence est ignorée et une erreur est consignée dans la console.

<script id="keural-one-script">
  /* Code copié depuis l'onglet Jeton et installation */
</script>

Dans Next.js, insérez-le avec <Script id="keural-one-script" strategy="afterInteractive"> de next/script. Pour l'afficher sur toutes les pages, placez-le dans le layout racine.

Options de démarrage

Les valeurs transmises à boot sont prioritaires sur les paramètres de l'écran d'administration. Utilisez-les lorsque vous voulez changer l'apparence page par page.

Keural('boot', {
  token: 'wgt_…',
  theme: 'system',
  header: { enabled: true, extended: true, draggable: true, title: 'Assistance client', color: '#495BD8' },
  button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});
OptionValeurNom du paramètre à l'écran
tokenObligatoire. Jeton du code d'installation—
themelight · dark · system—
header.enabledAfficher l'en-têteAfficher l'en-tête
header.extendedAffiche le bouton d'agrandissement dans l'en-têteÉtendre l'en-tête
header.draggablePermet de déplacer la fenêtre en faisant glisser l'en-tête (true par défaut)—
header.titleTitre de l'en-têteNom du chatbot
header.colorCouleur de l'en-têteCouleur de l'en-tête
button.visibleAfficher le boutonAfficher le bouton
button.iconUrlAdresse de l'image du boutonImage du bouton
button.colorCouleur du boutonCouleur du bouton
button.positionleft · rightPosition du bouton
button.offsetX · button.offsetYDistance par rapport au bord de l'écran (px)Décalage X · Décalage Y

Les valeurs par défaut d'un nouveau chatbot sont : en-tête affiché et étendu, couleur de l'en-tête et du bouton #495BD8, à droite, décalage de 30 px, thème system.

Contrôle de la page

AppelAction
Keural('open') · Keural.open()Ouvre la fenêtre du chatbot.
Keural('close') · Keural.close()Ferme la fenêtre.
Keural('toggle') · Keural.toggle()Ferme la fenêtre si elle est ouverte, l'ouvre si elle est fermée.
Keural('reload') · Keural.reload()Recharge la fenêtre du chatbot.
Keural('badge', n) · Keural.badge(n)Affiche un badge numérique sur le bouton.
Keural.isLoaded()true lorsque le script est entièrement chargé
Keural.onOpen(cb) · Keural.onClose(cb)Appelle cb lorsque la fenêtre s'ouvre ou se ferme.

Les méthodes comme Keural.open() ne fonctionnent qu'une fois le script entièrement chargé. Si vous les appelez juste après le chargement de la page, utilisez la forme fonction Keural('open'), qui s'exécute dans l'ordre.

<button onclick="Keural('open')">Nous contacter</button>

Vous pouvez aussi masquer le bouton par défaut (button.visible: false) et ouvrir le chatbot depuis un bouton de votre propre page.

Taille de l'écran

La fenêtre du chatbot mesure 390×800 px. Si la largeur de l'écran est de 480 px ou moins, elle s'ouvre en plein écran. Le bouton d'agrandissement de l'en-tête permet d'agrandir la fenêtre.

Domaines d'affichage

  • Le chatbot s'ouvre sur les pages dont l'hôte est identique au domaine de base. L'hôte est comparé avec son port, sans tenir compte de la casse. Une adresse avec www. et un sous-domaine sont considérés comme des hôtes différents. Pour tester sur un serveur de développement, créez un chatbot distinct dont le domaine de base est cette adresse.
  • Le domaine de base ne peut pas être modifié après sa création. Pour le changer, créez un nouveau chatbot.
  • Si la liste des domaines autorisés dans Avancé est vide, le chatbot s'ouvre sur toutes les pages du domaine de base. Si vous ajoutez des domaines autorisés, il ne s'ouvre que sur les pages commençant par ces adresses. Si vous indiquez un chemin, comme https://example.com/help, l'ouverture est limitée aux pages situées sous ce chemin. Les domaines autorisés commencent par http:// ou https://, et vous pouvez en saisir 5 au maximum.
  • Le jeton du code d'installation est visible sur la page. Ne reliez au chatbot que du contenu que vous pouvez rendre public.

Politique de sécurité du contenu (CSP)

Si votre site applique une Content-Security-Policy, autorisez les éléments suivants. Les adresses sont celles de keural.ai.

DirectiveÀ autoriser
script-srchttps://keural.ai et le script en ligne du code d'installation ('unsafe-inline', ou hash ou nonce)
connect-srchttps://api.keural.ai
frame-srchttps://keural.ai
style-src'unsafe-inline' ou nonce (le chatbot ajoute des styles à la page)
img-srcL'adresse de l'image du bouton, https://keural.ai et https://api.keural.ai

Sur cette page