Drupal-chattbotmodul

Använd ChattyBox officiella Drupal-modul när du vill ha en Composer-hanterad installation för en Drupal 10- eller Drupal 11-webbplats. Den laddar den hostade widgeten på offentliga HTML-rutter och konfigurerar produktions-API-slutpunkten automatiskt.

Innan du installerar

Slutför först flödet Kom igång: anslut din offentliga Drupal-URL, granska indexerade sidor och verifiera representativa svar i Test Chat. Skapa sedan en webbläsarsäker offentlig nyckel under Public Keys och kopiera den från projektets flik Embed.

Composer-installation

Lägg till det offentliga GitHub-repositoryt i rotens composer.json i det Drupal-projekt som använder modulen:

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

Om projektet redan har ett avsnitt repositories slår du ihop posten chattybox-drupal med det. Installera sedan den taggade modulen:

composer require openstaticfish/chattybox-drupal:^0.1

Paketet är deklarerat som drupal-module och kräver Drupal ^10 || ^11. Drupals vanliga Composer-installationssökvägar placerar det under web/modules/contrib/.

Om du i stället vill testa den aktuella utvecklingsgrenen:

composer require openstaticfish/chattybox-drupal:dev-main

Aktivera och konfigurera

1. Aktivera ChattyBox från Extend eller kör drush en chattybox.
2. Öppna Configuration > Web services > ChattyBox.
3. Klistra endast in widgetens offentliga API-nyckel från projektets flik Embed.
4. Behåll URL:en till det hostade widgetsriptet om inte ChattyBox har tillhandahållit en förhandsgransknings- eller självhostad loader-URL.
5. Lämna språköverskrivningen tom för att följa sidans eller webbläsarens språk, eller ange en kod med två bokstäver som en, fr eller de.
6. Aktivera chattboten och spara konfigurationen.

Modulen laddas inte på administrativa rutter eller i svar som inte är HTML. Den lägger till den offentliga nyckeln, den hanterade produktionsslutpunkten, valfritt språk och widgetens loader via Drupals deklarerade bibliotek och drupalSettings.

Uteslut ytterligare rutter

Modulen hoppar automatiskt över administrativa rutter. En anpassad modul kan inaktivera widgeten på ytterligare offentliga rutter med 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;
  }
}

Manuell reservlösning

Composer är den rekommenderade installationsvägen. Om din Drupal-deployment inte kan använda Composer kopierar du modulen till web/modules/custom/chattybox eller en annan katalog för anpassade moduler, aktiverar den och konfigurerar den från Configuration > Web services > ChattyBox.

Klistra inte in en administrativ inloggning i modulen. Widgetens offentliga API-nyckel är avsedd för frontend-markup.

Verifiering

Efter att du har konfigurerat modulen:

• Öppna en offentlig Drupal-sida i ett inkognitofönster.
• Bekräfta att widgetens startknapp visas en gång.
• Ställ en riktig besökarfråga.
• Kontrollera att svaret innehåller källhänvisningar till offentliga Drupal-sidor.
• Kontrollera webbläsarkonsolen efter saknad data-api-key, data-api-url eller nyckelfel.

Följ lanseringschecklistan innan du tillkännager chattboten.