Modul Chatbot Drupal

Gunakan modul Drupal resmi ChattyBox saat Anda menginginkan instalasi yang dikelola Composer untuk situs Drupal 10 atau Drupal 11. Modul ini memuat widget ter-host pada rute HTML publik dan mengonfigurasi endpoint API produksi secara otomatis.

Sebelum Menginstal

Selesaikan alur Memulai terlebih dahulu: hubungkan URL Drupal publik Anda, tinjau halaman yang diindeks, dan verifikasi jawaban yang mewakili di Test Chat. Kemudian buat kunci publik yang aman untuk browser di Public Keys dan salin dari tab Embed proyek.

Instalasi Composer

Tambahkan repositori GitHub publik ke composer.json root proyek Drupal yang menggunakannya:

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

Jika proyek sudah memiliki bagian repositories, gabungkan entri chattybox-drupal ke dalamnya. Lalu instal modul bertag:

composer require openstaticfish/chattybox-drupal:^0.1

Paket dideklarasikan sebagai drupal-module dan memerlukan Drupal ^10 || ^11. Jalur penginstal Composer Drupal standar menempatkannya di web/modules/contrib/.

Untuk menguji branch pengembangan saat ini:

composer require openstaticfish/chattybox-drupal:dev-main

Mengaktifkan dan Mengonfigurasi

1. Aktifkan ChattyBox dari Extend, atau jalankan drush en chattybox.
2. Buka Configuration > Web services > ChattyBox.
3. Tempel hanya kunci API widget publik dari tab Embed proyek.
4. Biarkan URL skrip widget ter-host kecuali ChattyBox telah memberikan URL loader pratinjau atau self-hosted.
5. Biarkan penggantian bahasa kosong agar mengikuti bahasa halaman atau browser, atau masukkan kode dua huruf seperti en, fr, atau de.
6. Aktifkan chatbot dan simpan konfigurasi.

Modul tidak dimuat pada rute administratif atau respons non-HTML. Modul menambahkan kunci publik, endpoint produksi terkelola, lokal opsional, dan loader widget melalui library Drupal yang dideklarasikan serta drupalSettings.

Mengecualikan Rute Tambahan

Modul secara otomatis melewati rute administratif. Modul khusus dapat menonaktifkan widget pada rute publik tambahan dengan 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;
  }
}

Fallback Manual

Composer adalah jalur instalasi yang direkomendasikan. Jika deployment Drupal Anda tidak dapat menggunakan Composer, salin modul ke web/modules/custom/chattybox atau direktori modul khusus lainnya, aktifkan, lalu konfigurasikan dari Configuration > Web services > ChattyBox.

Jangan menempelkan kredensial manajemen ke dalam modul. Kunci API widget publik ditujukan untuk markup frontend.

Verifikasi

Setelah mengonfigurasi modul:

• Buka halaman Drupal publik di jendela penyamaran.
• Pastikan peluncur widget muncul satu kali.
• Ajukan pertanyaan pengunjung yang nyata.
• Pastikan jawaban menyertakan sitasi sumber ke halaman Drupal publik.
• Periksa konsol browser untuk data-api-key, data-api-url yang hilang, atau kesalahan kunci.

Lanjutkan ke daftar periksa peluncuran sebelum mengumumkan chatbot.