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. Panduan ini mencakup penyiapan operasional. Halaman modul chatbot AI Drupal membahas produk dan alur evaluasinya.

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

Modul saat ini didistribusikan sebagai paket bertag di repositori GitHub publik. Modul belum tercantum di Drupal.org atau Packagist, sehingga Composer memerlukan deklarasi repositori VCS di bawah sebelum composer require dapat menemukannya.

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/.

Tinjau sumber modul Drupal publik dan perubahan bertag sebelum melakukan upgrade. Pembaruan Drupal.org yang dikelola direktori belum tersedia.

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 override bahasa kosong agar mengikuti kebijakan locale proyek, atau masukkan kode huruf kecil yang didukung seperti en, fr, atau de. Dalam mode otomatis, bahasa halaman menang atas bahasa browser; mode Fixed memakai default proyek. Override hanya berlaku jika proyek mengizinkan override skrip.
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.

Instalasi baru dimulai dalam keadaan nonaktif dengan kunci dan override locale kosong. Formulir pengaturan ada di /admin/config/services/chattybox dan memerlukan izin administer chattybox configuration. Modul memuat widget; modul tidak melakukan crawl atau menyinkronkan konten Drupal.

Endpoint API tertanam di modul, bukan ditemukan dari kunci. Mengubah URL loader tidak mengubah endpoint itu. Jika cuplikan Embed memakai deployment API lain, gunakan cuplikan widget manual tanpa modul. URL skrip remote harus HTTPS (HTTP hanya diizinkan untuk host pengembangan lokal).

Kunci publik bekerja lintas origin browser secara default. Jika Anda mengaktifkan pembatasan di Public Keys > Edit origins, cantumkan setiap skema, hostname, dan port yang dituju. Origin request yang hilang atau tidak diizinkan menghasilkan 401 Invalid API key.

Mengecualikan Rute Tambahan

Modul secara otomatis melewati rute administratif. Modul khusus dapat menonaktifkan widget pada rute publik tambahan dengan hook_chattybox_load_widget_alter():

Pemeriksaan rute administratif bukan pemeriksaan privasi untuk semua konten frontend. Tambahkan pengecualian checkout, akun, dan keanggotaan bila sesuai.

/**
 * 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 yang didukung menyitasi halaman Drupal publik yang diindeks dan pertanyaan yang tidak didukung menampilkan fallback, yang dapat tidak memiliki sumber.
• Periksa konsol browser untuk data-api-key, data-api-url yang hilang, atau kesalahan kunci.
• Uji rute yang dikecualikan dan yang disertakan, saat cache Drupal/halaman/CDN hangat dan dingin. Bangun ulang cache yang relevan setelah mengubah pengaturan atau hook. Pengecualian rute server-side tidak melakukan teardown widget yang sudah dimuat selama navigasi sisi klien.

Lanjutkan ke daftar periksa peluncuran sebelum mengumumkan chatbot.