Drupal-chatbotmodule

Gebruik de officiële ChattyBox Drupal-module als je een door Composer beheerde installatie wilt voor een Drupal 10- of Drupal 11-site. De module laadt de gehoste widget op openbare HTML-routes en configureert het productie-API-eindpunt automatisch. Deze gids behandelt de operationele installatie. De pagina van de Drupal-AI-chatbotmodule beslaat het product en het evaluatieproces.

Voordat je installeert

Doorloop eerst Aan de slag: koppel je openbare Drupal-URL, bekijk geïndexeerde pagina's en controleer representatieve antwoorden in Test Chat. Maak daarna een browserveilige openbare sleutel in Public Keys en kopieer deze uit het tabblad Embed van het project.

Installatie met Composer

De module wordt momenteel verspreid als een getagd pakket in de openbare GitHub-repository. De module staat nog niet op Drupal.org of Packagist. Daarom heeft Composer de onderstaande VCS-repositorydeclaratie nodig voordat composer require het pakket kan vinden.

Voeg de openbare GitHub-repository toe aan de composer.json in de hoofdmap van het Drupal-project dat de module gebruikt:

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

Als het project al een sectie repositories heeft, voeg je de entry chattybox-drupal daarin samen. Installeer daarna de getagde module:

composer require openstaticfish/chattybox-drupal:^0.1

Het pakket is gedeclareerd als drupal-module en vereist Drupal ^10 || ^11. Standaardpaden van de Drupal Composer-installer plaatsen de module onder web/modules/contrib/.

Bekijk vóór een upgrade de openbare bron van de Drupal-module en de getagde wijzigingen. Updates die door Drupal.org worden beheerd, zijn nog niet beschikbaar.

Om in plaats daarvan de huidige ontwikkelbranch te testen:

composer require openstaticfish/chattybox-drupal:dev-main

Inschakelen en configureren

1. Schakel ChattyBox in via Extend of voer drush en chattybox uit.
2. Open Configuratie > Webservices > ChattyBox.
3. Plak alleen de openbare widget-API-sleutel uit het tabblad Embed van het project.
4. Laat de URL van het gehoste widgetscript staan, tenzij ChattyBox een preview- of self-hosted loader-URL heeft gegeven.
5. Laat de override leeg om het projectbeleid te volgen, of gebruik een ondersteunde code in kleine letters. In Auto-modus gaat paginataal vóór browsertaal; in Fixed-modus geldt de standaardlocale. Een override werkt alleen wanneer het project die toestaat.
6. Schakel de chatbot in en sla de configuratie op.

De module wordt niet geladen op administratieve routes of bij niet-HTML-antwoorden. Via Drupals gedeclareerde library en drupalSettings voegt de module de openbare sleutel, het beheerde productie-eindpunt, de optionele locale en de widgetloader toe. Deze guards zijn geen privacycontrole voor iedere frontendroute: sluit checkout-, account- en ledenroutes expliciet uit. De module crawlt of synchroniseert geen Drupal-inhoud.

Extra routes uitsluiten

De module slaat administratieve routes automatisch over. Een aangepaste module kan de widget op extra openbare routes uitschakelen met hook_chattybox_load_widget_alter():

Een server-side route-uitsluiting verwijdert geen widget die tijdens client-side navigatie al is geladen.

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

Handmatige fallback

Composer is de aanbevolen installatieroute. Als je Drupal-deployment Composer niet kan gebruiken, kopieer je de module naar web/modules/custom/chattybox of een andere map voor aangepaste modules, schakel je de module in en configureer je deze via Configuratie > Webservices > ChattyBox.

Plak geen beheerdersgegevens in de module. De openbare widget-API-sleutel is bedoeld voor frontend-markup.

Verificatie

Nadat je de module hebt geconfigureerd:

• Open een openbare Drupal-pagina in een incognitovenster.
• Controleer of de widgetlauncher één keer verschijnt.
• Stel een echte bezoekersvraag.
• Controleer dat een ondersteund antwoord geïndexeerde Drupal-pagina’s citeert en dat een niet-ondersteunde vraag de fallback toont, die geen bronnen kan hebben.
• Controleer de browserconsole op ontbrekende data-api-key, data-api-url of sleutelfouten. Test uitgesloten en opgenomen routes met warme en koude caches en bouw relevante caches opnieuw op na hook- of instellingenwijzigingen.

Doorloop de launchchecklist voordat je de chatbot aankondigt.