Lewati ke konten utama

Kebijakan

Versi dan perubahan​

Jalur di Referensi API adalah kontrak yang dipakai sistem lain untuk membangun integrasi. Karena itu, jalur ini berubah dengan cara sebuah kontrak berubah.

  • Perubahan yang merusak hanya dibuat dengan versi baru. Kolom yang sudah ada tidak diganti artinya dan tidak dihapus diam-diam.
  • Penambahan dapat terjadi kapan saja: kolom baru di jawaban, kode penolakan baru, peristiwa webhook baru. Abaikan kolom yang belum Anda kenal, dan jangan anggap daftar kode atau peristiwa sudah lengkap.
  • Bercabanglah pada code, bukan pada kalimat. Kalimat di message atau detail ditulis untuk dibaca orang dan bisa diubah kapan saja.
  • Setiap perubahan dicatat di Perubahan API dengan tanggalnya.

Endpoint layar operator Kareeb (yang dipakai aplikasi web dan ponsel) bukan bagian kontrak ini. Endpoint itu mengikuti kebutuhan layar dan bisa berubah kapan saja. Bangun integrasi hanya di atas jalur di Referensi API.

Penghentian​

Sebelum sebuah bentuk lama dihentikan, Anda diberi tahu lebih dulu di halaman Perubahan API, lengkap dengan tanggal berhentinya. Selama masa peralihan, bentuk lama tetap dikirim berdampingan dengan bentuk baru, sehingga sistem Anda bisa pindah tanpa terputus.

Terlalu banyak permintaan​

Bila sistem Anda mengirim terlalu banyak permintaan, Kareeb menjawab 429 dengan header Retry-After. Tunggu sebanyak detik yang disebut di header itu, lalu ulangi permintaan yang sama dengan idempotency_key yang sama. Jangan mengulang lebih cepat dari itu.

Penyimpanan data​

Aturan penyimpanan dan penghapusan data pelanggan ada di Kebijakan privasi Kareeb. Beberapa hal yang berkaitan langsung dengan API:

  • Lampiran pesan disimpan selama masa simpan lampiran yang diatur organisasi Anda. Setelah itu berkasnya dihapus; baris pesannya tetap, dan media_dihapus_pada di GET /api/export/messages menunjukkan kapan berkas itu dihapus.
  • Teks sebutan di halaman Pemantauan dihapus pada kedaluwarsa_pada, pada batas masa simpan Pemantauan, atau saat sistem Anda memanggil POST /api/pemantauan/hapus.
  • Catatan kiriman webhook disimpan 30 hari.

Keamanan​

  • Semua permintaan memakai HTTPS. Token hanya dikirim di header Authorization, tidak pernah di URL.
  • Simpan token dan secret webhook di tempat penyimpanan rahasia sistem Anda. Bila bocor, minta admin mencabut token atau membuat ulang langganan webhook.
  • Periksa tanda tangan setiap webhook sebelum memproses isinya (lihat Webhook).