Módulo de chatbot de Drupal

Usa el módulo oficial de Drupal de ChattyBox cuando quieras una instalación gestionada por Composer para un sitio Drupal 10 o Drupal 11. Carga el widget alojado en rutas HTML públicas y mantiene configurado automáticamente el endpoint de producción.

Antes de instalar

Completa primero el flujo de Primeros pasos: conecta tu URL pública de Drupal, revisa las páginas indexadas y verifica respuestas representativas en Test Chat. Después, crea una clave pública segura para el navegador en Public Keys y cópiala desde la pestaña Embed del proyecto.

Instalación con Composer

Añade el repositorio público de GitHub al composer.json raíz del proyecto Drupal que lo consuma:

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

Si el proyecto ya tiene una sección repositories, combina con ella la entrada chattybox-drupal. Después, instala el módulo etiquetado:

composer require openstaticfish/chattybox-drupal:^0.1

El paquete está declarado como drupal-module y requiere Drupal ^10 || ^11. Las rutas estándar del instalador Composer de Drupal lo colocan en web/modules/contrib/.

Para probar en su lugar la rama de desarrollo actual:

composer require openstaticfish/chattybox-drupal:dev-main

Activar y configurar

1. Activa ChattyBox desde Extend o ejecuta drush en chattybox.
2. Abre Configuration > Web services > ChattyBox.
3. Pega solo la clave API pública del widget desde la pestaña Embed del proyecto.
4. Deja la URL del script del widget alojado, a menos que ChattyBox te haya proporcionado una URL de loader de vista previa o autoalojada.
5. Deja vacío el cambio de idioma para seguir el idioma de la página o del navegador, o introduce un código de dos letras como en, fr o de.
6. Activa el chatbot y guarda la configuración.

El módulo no se carga en rutas administrativas ni en respuestas que no sean HTML. Añade la clave pública, el endpoint de producción gestionado, el idioma opcional y el loader del widget mediante la biblioteca declarada de Drupal y drupalSettings.

Excluir rutas adicionales

El módulo omite automáticamente las rutas administrativas. Un módulo personalizado puede desactivar el widget en otras rutas públicas con 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;
  }
}

Alternativa manual

Composer es la ruta de instalación recomendada. Si tu despliegue de Drupal no puede usar Composer, copia el módulo en web/modules/custom/chattybox o en otro directorio de módulos personalizados, actívalo y configúralo desde Configuration > Web services > ChattyBox.

No pegues credenciales de administración en el módulo. La clave API pública del widget está pensada para el marcado del frontend.

Verificación

Después de configurar el módulo:

• Abre una página pública de Drupal en una ventana de incógnito.
• Confirma que el lanzador del widget aparece una sola vez.
• Haz una pregunta real de visitante.
• Verifica que la respuesta incluye citas de fuentes que llevan a páginas públicas de Drupal.
• Comprueba la consola del navegador en busca de data-api-key, data-api-url ausentes o errores de clave.

Continúa con la lista de comprobación de lanzamiento antes de anunciar el chatbot.