Mulai integrasi API
Topik ini membantu tim teknis Anda memilih jenis API, membuat kredensial, mencoba kirim pesan, dan menerima status pengiriman lewat webhook. Rincian endpoint ada di topik referensi yang ditautkan di setiap bagian.
Siapa yang bisa memakai menu ini
Semua halaman di topik ini hanya untuk Admin. Setiap halaman juga baru muncul bila fitur API yang bersangkutan sudah diaktifkan pengelola aplikasi untuk bisnis Anda.
| Halaman | Fitur yang harus aktif |
|---|---|
| Developer > Akses API | API Message |
| Developer > Webhook | API Message |
| Developer > H2H CGW API Setup | Kompatibilitas API vendor |
| Developer > API CST | API CST ACS |
| Bantuan > Uji API | Salah satu fitur di atas |
Memilih jenis API
| Jenis API | Dipakai untuk | Kredensial dibuat di | Referensi |
|---|---|---|---|
| Business API v1 | Integrasi baru: kirim pesan, broadcast WhatsApp Business API, broadcast WhatsApp Web | Developer > Akses API | API, Testing & Kode Error |
| H2H dan CGW | Integrasi lama berformat H2H atau CGW yang dipindahkan ke aplikasi ini | Developer > H2H CGW API Setup | API H2H & CGW |
| CST ACS | Kirim template WhatsApp dengan format Dial WABA | Developer > API CST | API CST ACS |
Untuk integrasi baru, pilih Business API v1.
Membuat kredensial Business API v1
- Buka Developer > Akses API.
- Klik tombol buat di kanan atas.
- Isi Nama, misalnya
Integrasi Toko Sumber Rejeki. - Isi IP yang diizinkan bila Anda ingin membatasi alamat IP server yang boleh memakai kredensial ini. Bila kosong, semua alamat IP diterima.
- Klik Buat.
- Salin Public Key dan Secret Key yang tampil, lalu simpan di server integrasi Anda sebagai
<PUBLIC_KEY>dan<SECRET_KEY>.
Perlu diperhatikan,
- Secret Key hanya ditampilkan sekali. Aplikasi menyimpannya dalam bentuk hash, sehingga tidak bisa ditampilkan lagi.
- bila Secret Key hilang, buat ulang secret. Integrasi yang masih memakai secret lama langsung berhenti bekerja.
- permintaan dari alamat IP di luar daftar ditolak dengan kode
ip_not_allowed.
Membuat kredensial H2H, CGW, atau CST ACS
Kredensial H2H dan CGW dibuat di Developer > H2H CGW API Setup. Pilih Protokol sesuai format integrasi lama Anda, lalu isi data yang diminta form, termasuk URL webhook status bila integrasi Anda menerima laporan status.
Kredensial CST ACS dibuat di Developer > API CST. Pilih kanal WhatsApp yang dipakai untuk mengirim, lalu isi URL webhook status bila Anda ingin menerima laporan status.
Kedua halaman juga punya isian IP yang diizinkan. Cara pakai setiap kredensial dijelaskan di API H2H & CGW dan API CST ACS.
Mencoba kirim pesan di Uji API
Melalui halaman Bantuan > Uji API, Anda bisa mengirim pesan uji dengan kredensial Anda sendiri, lalu melihat request, respons, dan status pengirimannya.
- Buka Bantuan > Uji API.
- Pilih jenis API. Yang tampil hanya jenis API yang fiturnya aktif. H2H dan CGW baru tampil bila bisnis Anda sudah punya kredensial aktif untuk protokol tersebut.
- Isi data pesan, lalu kirim.
- Periksa request, respons, dan status pengiriman yang tampil.
Halaman ini juga menampilkan contoh kode dari isian Anda, termasuk contoh penerima webhook di server Anda. Kredensial tampil sebagai placeholder, kecuali Anda mencentang Tampilkan kredensial asli.
Perlu diperhatikan, pesan uji adalah pesan sungguhan yang benar-benar dikirim ke nomor tujuan.
Menerima status pengiriman lewat webhook
Untuk Business API v1, status pengiriman pesan (misalnya delivered, read, atau undelivered) dikirim ke URL webhook Anda.
- Buka Developer > Webhook.
- Klik Tambah Webhook, atau Buat Webhook Bisnis bila sudah ada webhook.
- Isi URL Webhook, misalnya
https://api.tokosumberrejeki.co.id/webhook/status. - Pastikan Aktif menyala, lalu klik Buat.
Setiap status membawa messageid yang sama dengan ID pesan dari respons kirim. Simpan ID tersebut agar status bisa dicocokkan dengan pesan Anda. Bentuk isi webhook dijelaskan di API, Testing & Kode Error.
Untuk H2H, CGW, dan CST ACS, webhook status diatur di form kredensial masing-masing, bukan di menu Webhook.
Sebagai informasi tambahan, topik Webhook menjelaskan webhook yang diterima aplikasi dari WhatsApp, Telegram, Instagram, dan pembayaran. Topik itu bukan untuk webhook status pesan Anda.
Batas permintaan
H2H, CGW, dan CST ACS dibatasi 600 permintaan per menit untuk setiap kredensial. Permintaan yang melewati batas ditolak, lalu bisa dicoba lagi pada menit berikutnya.