Drupal-chatbotmoduuli

Käytä virallista ChattyBoxin Drupal-moduulia, kun haluat Composerin hallitseman asennuksen Drupal 10- tai Drupal 11 -sivustolle. Se lataa isännöidyn widgetin julkisilla HTML-reiteillä ja määrittää tuotannon API-päätepisteen automaattisesti.

Ennen asennusta

Suorita ensin Aloittaminen -prosessi: yhdistä julkinen Drupal-URL-osoitteesi, tarkista indeksoidut sivut ja varmista edustavat vastaukset Test Chat -osiossa. Luo sitten selaimessa turvallinen julkinen avain kohdassa Public Keys ja kopioi se projektin Embed-välilehdeltä.

Composer-asennus

Lisää julkinen GitHub-repositorio sitä käyttävän Drupal-projektin juuren composer.json-tiedostoon:

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

Jos projektissa on jo repositories-osio, yhdistä chattybox-drupal-merkintä siihen. Asenna sitten merkitty moduuli:

composer require openstaticfish/chattybox-drupal:^0.1

Paketti on määritelty drupal-module-paketiksi ja se vaatii Drupalin ^10 || ^11. Drupalin tavalliset Composer-asennuspolut sijoittavat sen hakemistoon web/modules/contrib/.

Voit testata nykyistä kehityshaaraa sen sijaan näin:

composer require openstaticfish/chattybox-drupal:dev-main

Ota käyttöön ja määritä

1. Ota ChattyBox käyttöön kohdassa Extend tai suorita drush en chattybox.
2. Avaa Configuration > Web services > ChattyBox.
3. Liitä vain projektin Embed-välilehdeltä saatava widgetin julkinen API-avain.
4. Säilytä isännöidyn widget-komentosarjan URL-osoite, ellei ChattyBox ole antanut esikatselun tai itse isännöidyn loaderin URL-osoitetta.
5. Jätä kieliohitus tyhjäksi, jotta sivun tai selaimen kieltä käytetään, tai anna kaksikirjaiminen koodi, kuten en, fr tai de.
6. Ota chatbot käyttöön ja tallenna asetukset.

Moduulia ei ladata hallintareiteillä eikä muissa kuin HTML-vastauksissa. Se lisää julkisen avaimen, hallitun tuotannon päätepisteen, valinnaisen lokaalinsäätimen ja widgetin loaderin Drupalin ilmoitetun kirjaston sekä drupalSettings-asetusten kautta.

Sulje muita reittejä pois

Moduuli ohittaa hallintareitit automaattisesti. Mukautettu moduuli voi poistaa widgetin käytöstä muilla julkisilla reiteillä hook_chattybox_load_widget_alter()-funktion avulla:

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

Manuaalinen varavaihtoehto

Composer on suositeltu asennustapa. Jos Drupal-julkaisusi ei voi käyttää Composeria, kopioi moduuli hakemistoon web/modules/custom/chattybox tai muuhun mukautettujen moduulien hakemistoon, ota se käyttöön ja määritä se kohdassa Configuration > Web services > ChattyBox.

Älä liitä moduuliin hallintatunnusta. Widgetin julkinen API-avain on tarkoitettu frontend-merkintää varten.

Vahvistus

Kun olet määrittänyt moduulin:

• Avaa julkinen Drupal-sivu incognito-ikkunassa.
• Varmista, että widgetin käynnistin näkyy kerran.
• Esitä todellinen kävijän kysymys.
• Varmista, että vastaus sisältää lähdeviitteet julkisille Drupal-sivuille.
• Tarkista selaimen konsolista puuttuvat data-api-key- tai data-api-url-arvot ja avainvirheet.

Jatka julkaisun tarkistuslistaan ennen chatbotin julkistamista.