Referensi SDK
Setiap Keyda SDK — Android, iOS, React Native, Flutter, Ionic — menerapkan kontrak kecil yang sama. Jika Anda pernah menggunakan salah satunya, Anda sudah memahami semuanya.
API
| Telepon | Cara kerjanya |
|---|---|
init / initialize | Menyimpan client id Anda. Memvalidasinya dan gagal secara jelas jika formatnya salah. |
show | Menampilkan chat di atas aplikasi Anda. |
dismiss | Menutupnya. |
isShowing | Apakah ia sedang ditampilkan saat ini. |
Sengaja tidak ada hal lain. Tidak ada API pengiriman pesan, tidak ada penghitung pesan belum dibaca, tidak ada panggilan identitas pengguna — karena tidak satupun dari hal tersebut berfungsi secara ujung-ke-ujung (end-to-end), dan metode yang tidak berfungsi jauh lebih buruk daripada metode yang belum ada.
URL yang dibuka setiap SDK
{baseUrl}/chat/{clientId}baseUrl menggunakan standar https://keyda.in/business dan dapat ditimpa di setiap platform, untuk penahapan (staging) atau instalasi mandiri (self-hosted).
Mengapa menggunakan web view dan apa ruginya bagi Anda
Ada satu antarmuka obrolan, yang disajikan oleh platform, dan setiap permukaan memuatnya.
Yang Anda dapatkan: perubahan yang dibuat pemilik di dasbor — warna aksen, pesan sambutan, nama bot, penayangan langsung — menjangkau setiap aplikasi secara instan, tanpa rilis. Perbaikan diterapkan di mana-mana sekaligus. Obrolan identik di semua platform.
Biayanya: obrolan memerlukan koneksi internet. Belum ada mode offline dan belum ada pemberitahuan push.
Kami lebih baik Anda mengetahuinya sebelum Anda merilisnya daripada menyadarinya sesudahnya.
Jaminan yang diberikan oleh setiap SDK
- Navigasi keluar. Tautan ke asal mana pun akan terbuka di peramban sistem alih-alih menggantikan obrolan. Tanpa ini, satu ketukan pada tautan footer akan mengakhiri percakapan pelanggan tanpa jalan kembali.
- Kontinuitas percakapan. Penyimpanan DOM aktif, sehingga pelanggan yang menutup aplikasi dan kembali akan mendapati percakapan mereka di tempat terakhir (selama 24 jam).
- Papan ketik tidak akan pernah menutupi kolom input.
- Area aman dihargai — tidak ada obrolan yang digambar di bawah takik atau indikator beranda.
- Tidak ada kegagalan yang berdampak pada aplikasi Anda. Pemuatan yang gagal akan menampilkan tombol coba lagi.
- Tanpa analitik, tanpa pengenal perangkat, tanpa dependensi pihak ketiga. Menambahkan SDK Keyda tidak akan menambahkan pelacak ke aplikasi Anda.
Format Client id
kb_live_ followed by 8-48 hexadecimal charactersApa pun yang lain ditolak saat inisialisasi alih-alih membuka 404 di depan pelanggan. Client ID bersifat publik secara desain — terlihat di situs web mana pun yang menyematkan widget — dan tidak memiliki kemampuan untuk membaca atau mengubah akun Anda. Lihat batasan dan keamanan.
Sumber
Publik, berlisensi MIT: github.com/KeydaAI/keyda-business-sdks. Kontrak bersama yang wajib dipatuhi setiap paket ada di CONTRACT.md di bagian atas repositori tersebut.