Mulai dengan API Kareeb
API Kareeb menghubungkan sistem Anda dengan Kareeb tanpa membuka layar operator. Sistem Anda bisa berupa SIMRS rumah sakit, aplikasi janji temu, atau gudang data. Semua permintaan memakai HTTPS ke https://kareeb.id, dengan badan dan jawaban dalam JSON.
Dua jenis pekerjaan
Mengirim pesan WhatsApp. Sistem Anda meminta Kareeb mengirim pesan ke pelanggan:
- satu pesan ke satu pelanggan lewat
POST /api/messages(lihat Kirim satu pesan); - satu template ke banyak nomor lewat
POST /api/broadcasts(lihat Broadcast).
Hasil kirimnya (terkirim, sampai, dibaca, gagal) datang ke sistem Anda lewat webhook.
Menarik data. Sistem Anda membaca data CRM untuk laporan atau gudang data: kontak, percakapan, pesan, kampanye beserta corongnya, pesanan, dan komentar. Semuanya lewat GET /api/export/... dengan satu aturan kursor yang sama (lihat Tarik data).
Token mana untuk apa
Setiap permintaan membawa satu token API dengan awalan kt_. Token dibuat oleh admin organisasi Anda di Kareeb dan membawa izin yang dipilih saat dibuat. Buat satu token per sistem, dengan izin secukupnya.
| Pekerjaan | Izin |
|---|---|
| Membaca daftar template | read:templates |
| Mengirim satu pesan | write:messages |
| Mengirim broadcast | send:broadcast |
| Membaca kontak | read:contacts |
| Membaca percakapan | read:conversations |
| Membaca pesan | read:messages |
| Membaca kampanye dan hasilnya | read:campaigns |
| Membaca pesanan | read:orders |
| Membaca komentar | read:comments |
| Mengirim sebutan ke halaman Pemantauan | write:pemantauan |
| Meminta token panggilan suara untuk aplikasi | write:suara |
Token gudang data cukup diberi izin baca. Dengan begitu, token itu tidak bisa mengirim pesan kepada siapa pun. Cara membuat token ada di Token API.
Mencoba tanpa sandbox
Kareeb tidak punya lingkungan sandbox. Setiap kiriman lewat API adalah pesan WhatsApp sungguhan. Untuk mencoba, kirim ke nomor Anda sendiri:
- Minta admin membuat token dengan izin
read:templatesdanwrite:messages. - Baca daftar template dan pilih satu yang berstatus
APPROVED(lihat Daftar template). - Kirim template itu ke nomor WhatsApp Anda sendiri dengan
POST /api/messages. - Admin juga bisa mencoba template dari menu Template di Kareeb dengan tombol Kirim tes.
Bagian yang hanya membaca data aman dicoba kapan saja karena tidak mengirim apa pun.
Referensi lengkap
Semua endpoint, kolom, dan kode penolakan ada di Referensi API. Berkas OpenAPI-nya bisa diunduh di kareeb-crm.json untuk dibuka di Postman atau pembuat klien.
Ke mana bertanya
Pertanyaan tentang integrasi diajukan lewat admin Kareeb di organisasi Anda. Admin itulah yang membuat token, menambahkan webhook, dan menghubungi tim Kareeb bila ada yang perlu diperiksa dari sisi kami.