Modiwl Chatbot Drupal

Defnyddiwch fodiwl Drupal swyddogol ChattyBox pan fyddwch eisiau gosodiad a reolir gan Composer ar gyfer safle Drupal 10 neu Drupal 11. Mae’n llwytho’r widget a gynhelir ar lwybrau HTML cyhoeddus ac yn cadw endpoint API cynhyrchu wedi’i ffurfweddu’n awtomatig.

Cyn Gosod

Cwblhewch y llif Cychwyn Arni yn gyntaf: cysylltwch eich URL Drupal cyhoeddus, adolygwch dudalennau sydd wedi’u mynegeio a gwiriwch atebion cynrychioliadol yn Test Chat. Yna crëwch allwedd gyhoeddus ddiogel i’r porwr yn Public Keys a’i chopïo o dab Embed y prosiect.

Gosod Composer

Ychwanegwch y storfa GitHub gyhoeddus at composer.json gwraidd y prosiect Drupal sy’n ei defnyddio:

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

Os oes gan y prosiect adran repositories eisoes, unwch y cofnod chattybox-drupal â hi. Yna gosodwch y modiwl wedi’i dagio:

composer require openstaticfish/chattybox-drupal:^0.1

Mae’r pecyn wedi’i ddatgan fel drupal-module ac mae angen Drupal ^10 || ^11 arno. Mae llwybrau gosod Composer Drupal safonol yn ei roi o dan web/modules/contrib/.

I brofi’r gangen ddatblygu gyfredol yn lle hynny:

composer require openstaticfish/chattybox-drupal:dev-main

Galluogi a Ffurfweddu

1. Galluogwch ChattyBox o Extend, neu rhedwch drush en chattybox.
2. Agorwch Configuration > Web services > ChattyBox.
3. Gludwch allwedd API gyhoeddus y widget yn unig o dab Embed y prosiect.
4. Gadewch URL sgript y widget a gynhelir, oni bai bod ChattyBox wedi darparu URL loader rhagolwg neu hunangynhaliol.
5. Gadewch y diystyru iaith yn wag i ddilyn iaith y dudalen neu’r porwr, neu nodwch god dwy lythyren fel en, fr neu de.
6. Galluogwch y chatbot ac arbedwch y ffurfweddiad.

Nid yw’r modiwl yn llwytho ar lwybrau gweinyddol nac ar gyfer ymatebion nad ydynt yn HTML. Mae’n ychwanegu’r allwedd gyhoeddus, endpoint cynhyrchu a reolir, locale dewisol a loader y widget drwy lyfrgell ddatganedig Drupal a drupalSettings.

Eithrio Llwybrau Ychwanegol

Mae’r modiwl yn hepgor llwybrau gweinyddol yn awtomatig. Gall modiwl pwrpasol analluogi’r widget ar lwybrau cyhoeddus ychwanegol gyda 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;
  }
}

Wrth Gefn â Llaw

Composer yw’r llwybr gosod a argymhellir. Os na all eich deployment Drupal ddefnyddio Composer, copïwch y modiwl i web/modules/custom/chattybox neu gyfeiriadur modiwl pwrpasol arall, ei alluogi a’i ffurfweddu o Configuration > Web services > ChattyBox.

Peidiwch â gludo manylyn rheoli i’r modiwl. Mae allwedd API gyhoeddus y widget wedi’i bwriadu ar gyfer marcio frontend.

Dilysu

Ar ôl ffurfweddu’r modiwl:

• Agorwch dudalen Drupal gyhoeddus mewn ffenestr incognito.
• Cadarnhewch fod lansiwr y widget yn ymddangos unwaith.
• Gofynnwch gwestiwn go iawn gan ymwelydd.
• Gwiriwch fod yr ateb yn cynnwys dyfyniadau ffynhonnell sy’n arwain at dudalennau Drupal cyhoeddus.
• Gwiriwch gonsol y porwr am data-api-key, data-api-url coll neu wallau allwedd.

Ewch ymlaen â’r rhestr wirio lansio cyn cyhoeddi’r chatbot.