Modul chatbotu Drupal

Oficiální modul Drupal ChattyBox použijte, pokud chcete instalaci spravovanou Composerem pro web Drupal 10 nebo Drupal 11. Na veřejných HTML routách načte hostovaný widget a produkční koncový bod API nakonfiguruje automaticky.

Než začnete s instalací

Nejprve dokončete postup Začínáme: připojte veřejnou URL Drupalu, projděte indexované stránky a ověřte reprezentativní odpovědi v Test Chat. Poté vytvořte veřejný klíč bezpečný pro prohlížeč v Public Keys a zkopírujte jej z karty Embed projektu.

Instalace pomocí Composeru

Přidejte veřejný repozitář GitHub do kořenového composer.json používaného projektu Drupal:

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

Pokud projekt už obsahuje sekci repositories, sloučte s ní položku chattybox-drupal. Poté nainstalujte označený modul:

composer require openstaticfish/chattybox-drupal:^0.1

Balíček je deklarován jako drupal-module a vyžaduje Drupal ^10 || ^11. Standardní instalační cesty Drupal Composeru jej umístí do web/modules/contrib/.

Chcete-li místo toho otestovat aktuální vývojovou větev:

composer require openstaticfish/chattybox-drupal:dev-main

Povolení a konfigurace

1. Povolte ChattyBox v části Extend nebo spusťte drush en chattybox.
2. Otevřete Configuration > Web services > ChattyBox.
3. Vložte pouze veřejný API klíč widgetu z karty Embed projektu.
4. URL hostovaného skriptu widgetu ponechte beze změny, pokud vám ChattyBox neposkytl URL loaderu pro náhled nebo vlastní hostování.
5. Přepsání jazyka ponechte prázdné, aby se použil jazyk stránky nebo prohlížeče, případně zadejte dvoupísmenný kód jako en, fr nebo de.
6. Povolte chatbot a uložte konfiguraci.

Modul se nenačítá na administrativních routách ani u odpovědí, které nejsou HTML. Pomocí deklarované knihovny Drupalu a drupalSettings přidává veřejný klíč, spravovaný produkční koncový bod, volitelný locale a loader widgetu.

Vyloučení dalších rout

Modul administrativní routy automaticky vynechává. Vlastní modul může widget vypnout na dalších veřejných routách 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;
  }
}

Ruční záložní varianta

Composer je doporučený způsob instalace. Pokud vaše nasazení Drupalu nemůže Composer použít, zkopírujte modul do web/modules/custom/chattybox nebo jiného adresáře vlastních modulů, povolte jej a nakonfigurujte v Configuration > Web services > ChattyBox.

Do modulu nevkládejte přihlašovací údaje pro správu. Veřejný API klíč widgetu je určen pro frontendové značky.

Ověření

Po konfiguraci modulu:

• Otevřete veřejnou stránku Drupalu v anonymním okně.
• Ověřte, že se launcher widgetu zobrazí právě jednou.
• Položte skutečnou otázku návštěvníka.
• Zkontrolujte, že odpověď obsahuje citace zdrojů vedoucí na veřejné stránky Drupalu.
• Zkontrolujte konzoli prohlížeče, zda nechybí data-api-key, data-api-url nebo zda neobsahuje chyby klíče.

Před oznámením chatbota pokračujte podle kontrolního seznamu spuštění.