Module de chatbot Drupal

Utilisez le module Drupal officiel de ChattyBox si vous souhaitez une installation gérée par Composer pour un site Drupal 10 ou Drupal 11. Il charge le widget hébergé sur les routes HTML publiques et configure automatiquement le point de terminaison API de production.

Avant l’installation

Suivez d’abord le parcours Prise en main : connectez votre URL Drupal publique, examinez les pages indexées et vérifiez des réponses représentatives dans Test Chat. Créez ensuite une clé publique compatible avec le navigateur dans Public Keys et copiez-la depuis l’onglet Embed du projet.

Installation avec Composer

Ajoutez le dépôt GitHub public à la racine composer.json du projet Drupal qui le consomme :

{
  "repositories": {
    "chattybox-drupal": {
      "type": "vcs",
      "url": "https://github.com/OpenStaticFish/chattybox-drupal.git"
    }
  }
}

Si le projet possède déjà une section repositories, fusionnez-y l’entrée chattybox-drupal. Installez ensuite le module balisé :

composer require openstaticfish/chattybox-drupal:^0.1

Le package est déclaré comme drupal-module et nécessite Drupal ^10 || ^11. Les chemins d’installation Composer standard de Drupal le placent sous web/modules/contrib/.

Pour tester à la place la branche de développement actuelle :

composer require openstaticfish/chattybox-drupal:dev-main

Activer et configurer

1. Activez ChattyBox depuis Extend, ou exécutez drush en chattybox.
2. Ouvrez Configuration > Web services > ChattyBox.
3. Collez uniquement la clé API publique du widget depuis l’onglet Embed du projet.
4. Conservez l’URL du script du widget hébergé, sauf si ChattyBox vous a fourni une URL de loader de prévisualisation ou auto-hébergée.
5. Laissez le remplacement de langue vide pour suivre la langue de la page ou du navigateur, ou saisissez un code à deux lettres tel que en, fr ou de.
6. Activez le chatbot et enregistrez la configuration.

Le module ne se charge pas sur les routes d’administration ni pour les réponses non HTML. Il ajoute la clé publique, le point de terminaison de production géré, la langue facultative et le loader du widget via la bibliothèque déclarée de Drupal et drupalSettings.

Exclure d’autres routes

Le module ignore automatiquement les routes d’administration. Un module personnalisé peut désactiver le widget sur d’autres routes publiques avec hook_chattybox_load_widget_alter() :

/**
 * Implements hook_chattybox_load_widget_alter().
 */
function mymodule_chattybox_load_widget_alter(&$should_load, $config, $route_match) {
  if ('commerce_checkout.form' === $route_match->getRouteName()) {
    $should_load = FALSE;
  }
}

Solution de repli manuelle

Composer est la méthode d’installation recommandée. Si votre déploiement Drupal ne peut pas utiliser Composer, copiez le module dans web/modules/custom/chattybox ou un autre répertoire de modules personnalisés, activez-le et configurez-le depuis Configuration > Web services > ChattyBox.

Ne collez pas d’identifiant de gestion dans le module. La clé API publique du widget est destinée au balisage frontend.

Vérification

Après avoir configuré le module :

• Ouvrez une page Drupal publique dans une fenêtre de navigation privée.
• Vérifiez que le lanceur du widget apparaît une seule fois.
• Posez une vraie question de visiteur.
• Vérifiez que la réponse contient des citations renvoyant aux pages Drupal publiques.
• Consultez la console du navigateur pour détecter l’absence de data-api-key, data-api-url ou des erreurs de clé.

Consultez la checklist de lancement avant d’annoncer le chatbot.