Lewati ke konten
KeuralDocs
Pengembang

Chatbot

Pasang tombol chatbot Keural di situs web organisasi dengan kode instalasi.

Organisasi dapat memasang chatbot Keural di situs webnya sendiri. Pengunjung menekan tombol di sudut layar, lalu jendela chatbot terbuka. Pasang dengan menempelkan kode instalasi yang dibuat di layar admin ke situs web.

Cara membuat

  1. Pemilik atau admin organisasi menekan Tambah chatbot di Manajemen organisasi → Kelola chatbot.
  2. Masukkan nama chatbot dan domain dasar (contoh: https://example.com), lalu daftarkan.
  3. Buka chatbot dan atur ketiga tab.
TabPengaturan
Token·Kode instalasiMemeriksa token, menyalin kode instalasi (HTML · Next.js)
Pengaturan UI chatbotGambar tombol (PNG·JPG·GIF·WebP) dan tampilnya, nama chatbot, tampilan·perluasan·warna header, warna tombol, posisi tombol (kiri·kanan), serta offset horizontal·vertikal. Periksa dengan pratinjau
Pengaturan lanjutanAlamat halaman tempat chatbot boleh dibuka (domain yang diizinkan, maksimal 5)
  1. Tempel kode instalasi ke situs web Anda.

Kode instalasi

Di tab Token·Kode instalasi, salin kode untuk HTML atau Next.js. Kode terdiri dari dua bagian.

  • Loader: membuat fungsi Keural, lalu memuat skrip chatbot (/plugin/keural-widget@1.0.1.js) secara asinkron setelah halaman selesai dimuat. Perintah yang dipanggil sebelum skrip dimuat disimpan dalam antrean dan dijalankan berurutan.
  • Perintah awal: Keural('boot', { token: '…' }). Token diawali wgt_.

Versi skrip terkunci pada alamat tersebut. Saat ada versi baru, salin ulang kode instalasi dan ganti. Jika kode instalasi dipasang dua kali pada halaman yang sama, kode kedua diabaikan dan konsol mencatat error.

<script id="keural-one-script">
  /* Kode yang disalin dari tab Token·Kode instalasi */
</script>

Di Next.js, pasang dengan <Script id="keural-one-script" strategy="afterInteractive"> dari next/script. Untuk menampilkan di semua halaman, letakkan di root layout.

Opsi awal

Nilai yang dimasukkan ke boot lebih diutamakan daripada pengaturan di layar admin. Gunakan ini untuk mengubah tampilan per halaman.

Keural('boot', {
  token: 'wgt_…',
  theme: 'system',
  header: { enabled: true, extended: true, draggable: true, title: 'Dukungan pelanggan', color: '#495BD8' },
  button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});
OpsiNilaiNama pengaturan di layar
tokenWajib. Token dari kode instalasi—
themelight · dark · system—
header.enabledMenampilkan headerTampilkan header
header.extendedMenampilkan tombol lihat besar di headerPerluas header
header.draggableHeader dapat ditarik untuk memindahkan jendela (default true)—
header.titleJudul headerNama chatbot
header.colorWarna headerWarna header
button.visibleMenampilkan tombolTampilkan tombol
button.iconUrlAlamat gambar tombolGambar tombol
button.colorWarna tombolWarna tombol
button.positionleft · rightPosisi tombol
button.offsetX · button.offsetYJarak dari tepi layar (px)Offset X · Offset Y

Nilai default chatbot baru adalah: tampilkan dan perluas header aktif, warna header dan tombol #495BD8, posisi kanan, offset 30px, dan tema system.

Mengendalikan dari halaman

PanggilanPerilaku
Keural('open') · Keural.open()Membuka jendela chatbot.
Keural('close') · Keural.close()Menutup jendela.
Keural('toggle') · Keural.toggle()Menutup jika terbuka, membuka jika tertutup.
Keural('reload') · Keural.reload()Memuat ulang jendela chatbot.
Keural('badge', n) · Keural.badge(n)Menampilkan lencana angka pada tombol.
Keural.isLoaded()true jika skrip sudah selesai dimuat
Keural.onOpen(cb) · Keural.onClose(cb)Memanggil cb saat jendela terbuka atau tertutup.

Metode seperti Keural.open() hanya berfungsi setelah skrip selesai dimuat. Jika dipanggil segera setelah halaman dimuat, gunakan bentuk fungsi seperti Keural('open') agar dijalankan berurutan.

<button onclick="Keural('open')">Hubungi kami</button>

Tombol bawaan dapat disembunyikan (button.visible: false), lalu chatbot dibuka dari tombol di halaman Anda.

Ukuran layar

Jendela chatbot berukuran 390×800px. Jika lebar layar 480px atau kurang, jendela terbuka layar penuh. Tombol lihat besar di header memperbesar jendela.

Tempat chatbot ditampilkan

  • Chatbot ditampilkan di halaman yang hostnya sama dengan domain dasar. Host dibandingkan termasuk port, dan huruf besar atau kecil tidak dibedakan. Alamat dengan www. dan subdomain dianggap host lain. Untuk menguji di server pengembangan, buat chatbot terpisah dengan alamat tersebut sebagai domain dasar.
  • Domain dasar tidak dapat diubah setelah dibuat. Untuk mengubahnya, buat chatbot baru.
  • Jika domain yang diizinkan di Pengaturan lanjutan dikosongkan, chatbot ditampilkan di semua halaman pada domain dasar. Jika domain yang diizinkan diisi, chatbot hanya ditampilkan di halaman yang alamatnya diawali domain tersebut. Jika menulis sampai path seperti https://example.com/help, cakupannya menjadi halaman di bawah path itu. Domain yang diizinkan harus diawali http:// atau https:// dan maksimal 5.
  • Token pada kode instalasi ditampilkan langsung di halaman. Hubungkan chatbot hanya dengan konten yang aman untuk dipublikasikan.

Kebijakan keamanan (CSP)

Jika situs menerapkan Content-Security-Policy, izinkan hal berikut. Alamat mengacu pada keural.ai.

DirektifYang diizinkan
script-srchttps://keural.ai, skrip inline dari kode instalasi ('unsafe-inline' atau hash·nonce)
connect-srchttps://api.keural.ai
frame-srchttps://keural.ai
style-src'unsafe-inline' atau nonce (chatbot menambahkan gaya ke halaman)
img-srcAlamat gambar tombol, https://keural.ai, https://api.keural.ai

Di halaman ini