Drupali vestlusroboti moodul

Kasutage ametlikku ChattyBoxi Drupali moodulit, kui soovite Drupal 10 või Drupal 11 saidile Composeri hallatavat paigaldust. See laadib hostitud vidina avalikel HTML-marsruutidel ja konfigureerib tootmise API lõpp-punkti automaatselt.

Enne paigaldamist

Lõpetage esmalt Alustamise töövoog: ühendage oma avalik Drupali URL, vaadake indekseeritud lehed üle ja kontrollige esinduslikke vastuseid jaotises Test Chat. Seejärel looge jaotises Public Keys brauseris turvaline avalik võti ja kopeerige see projekti vahekaardilt Embed.

Composeri paigaldus

Lisage avalik GitHubi hoidla seda kasutava Drupali projekti juurkausta composer.json-i:

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

Kui projektil on juba jaotis repositories, ühendage kirje chattybox-drupal sellega. Seejärel installige märgistatud moodul:

composer require openstaticfish/chattybox-drupal:^0.1

Pakett on deklareeritud kui drupal-module ja nõuab Drupali ^10 || ^11. Drupali standardsed Composeri installija teed paigutavad selle kausta web/modules/contrib/.

Praeguse arendusharu testimiseks kasutage selle asemel:

composer require openstaticfish/chattybox-drupal:dev-main

Lubamine ja seadistamine

1. Lubage ChattyBox jaotises Extend või käivitage drush en chattybox.
2. Avage Configuration > Web services > ChattyBox.
3. Kleepige projekti vahekaardilt Embed ainult avalik vidina API-võti.
4. Jätke hostitud vidina skripti URL alles, välja arvatud juhul, kui ChattyBox on andnud eelvaate või isehostitud laadija URL-i.
5. Jätke keele alistamine tühjaks, et järgida lehe või brauseri keelt, või sisestage kahetäheline kood, näiteks en, fr või de.
6. Lubage vestlusrobot ja salvestage seadistus.

Moodulit ei laadita haldusmarsruutidel ega mitte-HTML-vastuste puhul. See lisab avaliku võtme, hallatava tootmise lõpp-punkti, valikulise lokaadi ja vidina laadija Drupali deklareeritud teegi ning drupalSettings kaudu.

Täiendavate marsruutide välistamine

Moodul jätab haldusmarsruudid automaatselt vahele. Kohandatud moodul saab vidina täiendavatel avalikel marsruutidel keelata funktsiooniga 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;
  }
}

Käsitsi varuvariant

Composer on soovituslik paigaldusviis. Kui teie Drupali juurutus ei saa Composerit kasutada, kopeerige moodul kausta web/modules/custom/chattybox või mõnda teise kohandatud moodulite kataloogi, lubage see ja seadistage jaotises Configuration > Web services > ChattyBox.

Ärge kleepige moodulisse halduse mandaati. Avalik vidina API-võti on mõeldud frontend-märgistuse jaoks.

Kontrollimine

Pärast mooduli seadistamist:

• Avage avalik Drupali leht inkognitoaknas.
• Kontrollige, et vidina avaja ilmuks ühe korra.
• Esitage päris külastaja küsimus.
• Kontrollige, et vastus sisaldaks allikaviiteid avalikele Drupali lehtedele.
• Kontrollige brauserikonsooli puuduva data-api-key-i, puuduva data-api-url-i või võtmevigade suhtes.

Enne vestlusroboti väljakuulutamist läbige käivitamise kontrollnimekiri.