Drupal-Chatbot-Modul

Verwenden Sie das offizielle ChattyBox-Drupal-Modul, wenn Sie eine Composer-verwaltete Installation für eine Drupal-10- oder Drupal-11-Site wünschen. Es lädt das gehostete Widget auf öffentlichen HTML-Routen und konfiguriert den Produktions-API-Endpunkt automatisch.

Vor der Installation

Schließen Sie zuerst den Ablauf Erste Schritte ab: Verbinden Sie Ihre öffentliche Drupal-URL, überprüfen Sie indexierte Seiten und verifizieren Sie repräsentative Antworten in Test Chat. Erstellen Sie anschließend unter Public Keys einen browsersicheren öffentlichen Schlüssel und kopieren Sie ihn aus dem Projekt-Tab Embed.

Composer-Installation

Fügen Sie das öffentliche GitHub-Repository zur composer.json-Datei im Stammverzeichnis des verwendenden Drupal-Projekts hinzu:

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

Wenn das Projekt bereits einen Abschnitt repositories besitzt, führen Sie den Eintrag chattybox-drupal dort zusammen. Installieren Sie anschließend das markierte Modul:

composer require openstaticfish/chattybox-drupal:^0.1

Das Paket ist als drupal-module deklariert und benötigt Drupal ^10 || ^11. Die standardmäßigen Drupal-Composer-Installationspfade legen es unter web/modules/contrib/ ab.

Um stattdessen den aktuellen Entwicklungs-Branch zu testen:

composer require openstaticfish/chattybox-drupal:dev-main

Aktivieren und konfigurieren

1. Aktivieren Sie ChattyBox unter Extend oder führen Sie drush en chattybox aus.
2. Öffnen Sie Configuration > Web services > ChattyBox.
3. Fügen Sie nur den öffentlichen Widget-API-Schlüssel aus dem Projekt-Tab Embed ein.
4. Belassen Sie die URL des gehosteten Widget-Skripts, sofern ChattyBox Ihnen keine Vorschau- oder selbst gehostete Loader-URL bereitgestellt hat.
5. Lassen Sie die Sprachüberschreibung leer, damit die Seiten- oder Browsersprache verwendet wird, oder geben Sie einen zweistelligen Code wie en, fr oder de ein.
6. Aktivieren Sie den Chatbot und speichern Sie die Konfiguration.

Das Modul wird auf Verwaltungsrouten oder bei Nicht-HTML-Antworten nicht geladen. Es fügt öffentlichen Schlüssel, verwalteten Produktionsendpunkt, optionale Sprache und Widget-Loader über Drupals deklarierte Bibliothek und drupalSettings hinzu.

Weitere Routen ausschließen

Das Modul überspringt Verwaltungsrouten automatisch. Ein benutzerdefiniertes Modul kann das Widget auf weiteren öffentlichen Routen mit hook_chattybox_load_widget_alter() deaktivieren:

/**
 * 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;
  }
}

Manueller Fallback

Composer ist der empfohlene Installationsweg. Wenn Ihr Drupal-Deployment Composer nicht verwenden kann, kopieren Sie das Modul nach web/modules/custom/chattybox oder in ein anderes Verzeichnis für benutzerdefinierte Module, aktivieren Sie es und konfigurieren Sie es unter Configuration > Web services > ChattyBox.

Fügen Sie keine Verwaltungseinstellung in das Modul ein. Der öffentliche Widget-API-Schlüssel ist für Frontend-Markup vorgesehen.

Überprüfung

Nach der Konfiguration des Moduls:

• Öffnen Sie eine öffentliche Drupal-Seite in einem Inkognito-Fenster.
• Bestätigen Sie, dass der Widget-Launcher einmal erscheint.
• Stellen Sie eine echte Besucherfrage.
• Prüfen Sie, dass die Antwort Quellenangaben zu öffentlichen Drupal-Seiten enthält.
• Prüfen Sie die Browserkonsole auf fehlendes data-api-key, data-api-url oder Schlüssel-Fehler.

Arbeiten Sie die Launch-Checkliste ab, bevor Sie den Chatbot ankündigen.