Moduł chatbota Drupal

Użyj oficjalnego modułu Drupal ChattyBox, jeśli chcesz instalacji zarządzanej przez Composer dla witryny Drupal 10 lub Drupal 11. Moduł ładuje hostowany widżet na publicznych trasach HTML i automatycznie konfiguruje produkcyjny punkt końcowy API.

Zanim rozpoczniesz instalację

Najpierw ukończ proces Pierwsze kroki: połącz publiczny adres URL Drupal, przejrzyj zindeksowane strony i zweryfikuj reprezentatywne odpowiedzi w Test Chat. Następnie utwórz bezpieczny dla przeglądarki klucz publiczny w Public Keys i skopiuj go z karty Embed projektu.

Instalacja przez Composer

Dodaj publiczne repozytorium GitHub do głównego pliku composer.json używanego projektu Drupal:

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

Jeśli projekt ma już sekcję repositories, połącz z nią wpis chattybox-drupal. Następnie zainstaluj oznaczoną wersję modułu:

composer require openstaticfish/chattybox-drupal:^0.1

Pakiet jest zadeklarowany jako drupal-module i wymaga Drupal ^10 || ^11. Standardowe ścieżki instalatora Drupal Composer umieszczają go w web/modules/contrib/.

Aby zamiast tego przetestować bieżącą gałąź deweloperską:

composer require openstaticfish/chattybox-drupal:dev-main

Włączanie i konfiguracja

1. Włącz ChattyBox w Extend lub uruchom drush en chattybox.
2. Otwórz Configuration > Web services > ChattyBox.
3. Wklej wyłącznie publiczny klucz API widżetu z karty Embed projektu.
4. Pozostaw adres URL hostowanego skryptu widżetu, chyba że ChattyBox dostarczył adres URL loadera wersji podglądowej lub hostowanej samodzielnie.
5. Pozostaw zastąpienie języka puste, aby używać języka strony lub przeglądarki, albo wpisz dwuliterowy kod, np. en, fr lub de.
6. Włącz chatbota i zapisz konfigurację.

Moduł nie ładuje się na trasach administracyjnych ani przy odpowiedziach innych niż HTML. Dodaje publiczny klucz, zarządzany produkcyjny punkt końcowy, opcjonalny język i loader widżetu przez zadeklarowaną bibliotekę Drupal oraz drupalSettings.

Wykluczanie dodatkowych tras

Moduł automatycznie pomija trasy administracyjne. Niestandardowy moduł może wyłączyć widżet na dodatkowych trasach publicznych za pomocą 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;
  }
}

Ręczna instalacja awaryjna

Composer to zalecana ścieżka instalacji. Jeśli wdrożenie Drupal nie może korzystać z Composer, skopiuj moduł do web/modules/custom/chattybox lub innego katalogu modułów niestandardowych, włącz go i skonfiguruj w Configuration > Web services > ChattyBox.

Nie wklejaj do modułu poświadczeń administracyjnych. Publiczny klucz API widżetu jest przeznaczony do znaczników frontendu.

Weryfikacja

Po skonfigurowaniu modułu:

• Otwórz publiczną stronę Drupal w oknie incognito.
• Sprawdź, czy launcher widżetu pojawia się tylko raz.
• Zadaj prawdziwe pytanie odwiedzającego.
• Sprawdź, czy odpowiedź zawiera cytowania prowadzące do publicznych stron Drupal.
• Sprawdź konsolę przeglądarki pod kątem brakujących data-api-key, data-api-url lub błędów klucza.

Przejdź przez listę kontrolną uruchomienia przed ogłoszeniem chatbota.