Ringkasan
API Pengelolaan WhatsApp Business memungkinkan Anda untuk mengelola aset bisnis terkait WhatsApp, seperti Akun WhatsApp Business dan template pesan. API dibuat berdasarkan Marketing API dan memanfaatkan beberapa endpoint-nya, sehingga dokumentasi ini mungkin berisi tautan ke dokumentasi Marketing API jika diperlukan.
Persyaratan
- Akun Bisnis Meta.
- Akun WhatsApp Business, yang terkait dengan Akun Bisnis Meta Anda.
- Aplikasi bisnis, terkait dengan Akun Meta Business Anda.
- Jika aplikasi Anda mengakses endpoint yang menarget Akun Bisnis Anda, Anda akan memerlukan izin business_management.
- Jika aplikasi Anda mengakses endpoint Cloud API, Anda akan memerlukan izin whatsapp_business_messaging.
Token Akses
Platform ini mendukung jenis token akses berikut. Jenis yang Anda gunakan tergantung pada siapa yang akan menggunakan aplikasi Anda, dan apakah Anda adalah Partner Solusi atau bukan.
- Jika Anda adalah developer langsung, yang berarti hanya Anda atau bisnis Anda yang akan mengakses data Anda sendiri, gunakan token akses Pengguna Sistem.
- Jika Anda adalah Penyedia Layanan Teknologi, gunakan token akses Pengguna Sistem Integrasi Bisnis.
- Jika Anda adalah Partner Solusi, gunakan token akses Pengguna Sistem untuk membagikan lini kredit Anda dengan pelanggan yang baru di-onboarding, dan token akses Pengguna Sistem Integrasi Bisnis untuk hal lainnya.
Token Akses Pengguna Sistem
Token akses Pengguna Sistem mewakili Anda, bisnis atau organisasi Anda, atau orang-orang dalam bisnis atau organisasi Anda. Keuntungan utama dari token ini adalah tidak kedaluwarsa, dan dapat mewakili layanan otomatis dalam bisnis Anda yang tidak memerlukan input pengguna.
Token akses Pengguna Sistem adalah satu-satunya jenis token yang dapat digunakan oleh Partner Solusi untuk berbagi lini kredit dengan pelanggan yang di-onboarding.
Sebelum dapat membuat token akses Pengguna Sistem, Anda harus membuat pengguna sistem. Sebagian besar endpoint memeriksa apakah pengguna yang diidentifikasi oleh token memiliki akses ke sumber daya yang di-kueri. Jika pengguna tidak memiliki akses ke sumber daya, permintaan akan ditolak dengan kode kesalahan 200.
Pengguna sistem dapat berupa karyawan atau admin.
Pengguna Sistem Karyawan
Pengguna sistem karyawan harus diberikan akses ke tiap-tiap Akun WhatsApp Business yang dimiliki oleh, atau dibagikan dengan, bisnis Meta. Jika aplikasi Anda hanya membutuhkan akses ke beberapa Akun WhatsApp Business yang Anda miliki, pengguna sistem karyawan sudah cukup.
Setelah dibuat, Anda harus memberikan akses penuh atau parsial ke setiap Akun WhatsApp Business yang perlu diakses oleh pengguna sistem.
Pengguna Sistem Admin
Secara default, pengguna sistem admin memiliki akses penuh ke semua Akun WhatsApp Business dan aset yang dimiliki oleh atau dibagikan dengan Anda atau bisnis Anda.
Pengguna sistem admin berguna jika aplikasi Anda perlu mengakses Akun WhatsApp Business yang baru saja dibagikan dengan bisnis Anda; jika Anda menggunakan pengguna sistem karyawan, Anda harus secara manual memberikan akses ke setiap Akun WhatsApp Business yang telah dibagikan dengan Anda.
Perhatikan bahwa Anda dapat mengganti akses default pengguna sistem admin dengan memberikan akses parsial sesuai tiap Akun WhatsApp Business.
Membuat Pengguna Sistem
Untuk membuat pengguna sistem:
- Masuk ke Meta Business Suite.
- Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
- Klik Pengaturan bisnis.
- Buka Pengguna > Pengguna sistem.
- Klik tombol Tambahkan dan buat pengguna sistem admin atau karyawan.
Membuat Token Akses Pengguna Sistem
Untuk membuat token akses Pengguna Sistem setelah membuat pengguna sistem:
- Masuk ke Meta Business Suite.
- Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
- Klik Pengaturan bisnis.
- Buka Pengguna > Pengguna sistem.
- Pilih pengguna sistem yang sesuai dari daftar pengguna sistem.
- Klik tombol Buat token baru.
- Pilih aplikasi yang akan menggunakan token.
- Pilih izin apa pun yang dibutuhkan aplikasi agar berfungsi dengan baik dan membuat token.
Token Akses Pengguna Sistem Integrasi Bisnis
Token akses Pengguna Sistem Integrasi Bisnis masuk lingkup pelanggan yang telah di-onboarding dan sebaiknya digunakan oleh Penyedia Layanan Teknologi dan Partner Solusi saat mengakses data pelanggan yang telah di-onboarding.
Token ini berguna untuk aplikasi yang melakukan tindakan terprogram, otomatis pada Akun WhatsApp Business pelanggan, tanpa harus mengandalkan input pengguna aplikasi, atau memerlukan autentikasi ulang di masa mendatang.
Untuk membuat token akses Pengguna Sistem Integrasi Bisnis, Anda harus menerapkan Pendaftaran Tersemat (dikonfigurasikan dengan Facebook Login for Business) dan menukar kode yang diberikan kepada Anda ketika pelanggan menyelesaikan alur.
Lihat dokumen Pendaftaran Tersemat dan token akses Pengguna Sistem Integrasi Bisnis untuk mempelajari selengkapnya tentang token ini dan cara membuatnya.
Token Akses Pengguna
Meski token akses pengguna didukung dan dapat digunakan oleh semua developer aplikasi, Anda mungkin hanya akan menggunakannya ketika pertama kali menggunakan Dasbor Aplikasi untuk mengirim pesan uji pertama Anda. Saat Anda mengembangkan aplikasi, kemungkinan besar Anda akan beralih ke token akses Pengguna Sistem (dan akhirnya token akses Pengguna Sistem Bisnis, jika Anda adalah Penyedia Layanan Teknologi atau Partner Solusi). Ini karena token akses pengguna kedaluwarsa dengan cepat, sehingga Anda harus terus membuat yang baru setiap beberapa jam.
Ada beberapa cara untuk membuat token akses Pengguna:
- Akses panel Dasbor Aplikasi > WhatsApp > Pengaturan API. Panel ini selalu membuat token akses Pengguna baru setiap kali Anda mengunjunginya. Token akan secara otomatis masuk lingkup pengguna Anda, karena Anda masuk ke akun developer Anda ketika mengakses panel.
- Menggunakan Graph API Explorer.
- Menerapkan Facebook Login.
Menggunakan Token dalam Permintaan
Saat membuat permintaan API, sertakan token Anda dalam header permintaan otorisasi, didahului dengan Bearer. Contoh:
curl 'https://graph.facebook.com/v18.0/102290129340398/message_templates' \ -H 'Authorization: Bearer EAAJB...' \
Akses Akun WhatsApp Business
Banyak endpoint mewajibkan pengguna yang tokennya disertakan dalam permintaan API untuk juga diberikan akses parsial atau penuh ke Akun WhatsApp Business yang di-kueri (atau asetnya). Jika pengguna tidak memiliki akses, API akan menampilkan kode kesalahan 200.
Akses granular dapat diatur untuk setiap pengguna, termasuk pengguna sistem. Akses granular untuk pengguna sistem dapat berguna jika Anda ingin membatasi akses ke aset tertentu untuk sekelompok orang. Contoh: jika Anda memiliki bisnis besar dan ingin departemen tertentu hanya memiliki akses baca ke template Akun WhatsApp Business dan data nomor telepon bisnis, Anda dapat membuat pengguna sistem untuk departemen tersebut dan mengatur akses granular ke hanya lihat.
Untuk akses pengguna yang ditetapkan pada akun WhatsApp Business atau asetnya:
- Masuk ke Meta Business Suite.
- Temukan akun bisnis Anda di menu pilihan kiri atas dan klik ikon Pengaturan (rodagigi).
- Klik Pengaturan bisnis.
- Buka Akun > Akun WhatsApp.
- Pilih Akun WhatsApp Business yang sesuai.
- Pilih tab Akses Akun WhatsApp.
- Klik tombol +Tambahkan orang.
- Pilih pengguna sistem yang sesuai dan tetapkan level akses yang sesuai pada Akun WhatsApp Business.
Menguji Endpoint
Kami merekomendasikan penggunaan koleksi Postman atau cURL saat menguji endpoint. Meskipun Anda dapat menggunakan fitur Graph API Explorer, ini meneruskan token sebagai parameter string kueri, yang tidak kami sarankan (sebagai gantinya, teruskan token dalam permintaan judul).
Mendapatkan Informasi tentang Bisnis
Untuk mendapatkan informasi tentang bisnis, kirimkan permintaan GET ke endpoint WhatsAppBusinessAccount, dengan <WHATSAPP_BUSINESS_ACCOUNT_ID> adalah ID Akun WhatsApp Business Anda.
Contoh Permintaan
curl -i -X GET 'https://graph.facebook.com/v19.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Contoh Tanggapan
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"name": "Your WhatsApp Business Account Name",
"timezone_id": "1",
"message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f"
}
Untuk mendapatkan informasi spesifik tentang bisnis, seperti nama, template pesan dan nomor telepon, kirimkan permintaan GET ke endpoint WhatsAppBusinessAccount, dengan <WHATSAPP_BUSINESS_ACCOUNT_ID> adalah ID Akun WhatsApp Business Anda dan atur parameter fields ke daftar item yang ingin ditampilkan.
Contoh Permintaan
curl -i -X GET 'https://graph.facebook.com/v19.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Contoh Tanggapan
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"name": "Your WhatsApp Business Account Name",
"message_templates": {
"data": [
{
"name": "hello_world",
"components": [
{
"type": "HEADER",
"format": "TEXT",
"text": "Hello World"
},
{
"type": "BODY",
"text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us."
},
{
"type": "FOOTER",
"text": "WhatsApp Business Team"
}
],
"language": "en_US",
"status": "APPROVED",
"category": "ACCOUNT_UPDATE",
"id": "307191531401674"
},
{
"name": "sample_flight_confirmation",
"components": [
{
"type": "HEADER",
"format": "DOCUMENT"
},
{
"type": "BODY",
"text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}."
},
{
"type": "FOOTER",
"text": "Este mensaje proviene de un negocio no verificado."
}
],
"language": "es",
"status": "APPROVED",
"category": "TICKET_UPDATE",
},
...
Batas Laju
| Jenis Panggilan | Endpoint |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
| Jenis Panggilan | Endpoint |
|---|---|
|
|
|
|
|
|
|
|
Untuk informasi selengkapnya tentang cara mendapatkan penggunaan laju Anda saat ini, lihat Header.
Pelajari Selengkapnya
- Facebook SDK—Untuk meminta izin menggunakan Facebook Login kepada pengguna, Anda dapat menerapkan salah satu SDK kami.
- Pengelola Bisnis Marketing API–Pelajari selengkapnya tentang Pengelola Bisnis Marketing API.
- Tinjauan Aplikasi – Pelajari selengkapnya tentang proses untuk mengakses data Anda sendiri atau data yang dimiliki oleh orang lain.
- Tonton video Menyiapkan video Platform WhatsApp Business.
Langkah Berikutnya
- Panduan – Pelajari apa lagi yang dapat Anda lakukan dengan API Pengelolaan WhatsApp Business.
