Panduan produk

API key

Untuk menggunakan API Wbiztool, atau integrasi yang meminta kredensial Anda, Anda memerlukan tiga hal dari dashboard:

Kredensial	Field API	Tempat menemukannya
API Client ID	`client_id`	Settings → API Keys, di bagian atas halaman
API key	`api_key`	Settings → API Keys
WhatsApp Client ID	`whatsapp_client`	Kolom Whatsapp Client ID di WhatsApp settings

Sebelum memulai#

Anda harus menjadi Administrator workspace untuk melihat, membuat, atau menghapus API key. Lihat Peran dan izin.
Pilih workspace yang benar terlebih dahulu. Key dimiliki oleh workspace yang dipilih saat Anda membuatnya, dan permintaan API yang dibuat dengan key tersebut bekerja pada workspace itu. Lihat Beralih workspace.
Akun demo tidak dapat menggunakan API.

Menemukan API Client ID#

Buka Settings → API Keys. Kartu API Overview menampilkan API Client ID: diikuti sebuah angka. Gunakan angka ini sebagai client_id di setiap permintaan. Angka ini sama untuk setiap key di workspace.

Membuat API key#

Buka API Keys
Buka Settings dan klik tab API Keys, atau buka langsung /settings/?tab=api-keys.
Buat key
Di bawah New API Key, klik Create New (buat baru). Pesan sukses mengonfirmasi bahwa key telah dibuat, dan key tersebut muncul di tabel.
Salin key lengkap
Kolom API Key hanya menampilkan awal dan akhir setiap key. Klik tombol salin di sebelahnya (Copy Full API Key) untuk menyalin key lengkap, lalu tempelkan ke aplikasi atau integrasi Anda.

Key diberi nama otomatis berdasarkan jumlah key di workspace (API Key 1, API Key 2, dan seterusnya) dan tidak dapat diganti namanya. Setelah Anda menghapus key, key baru bisa mendapat nama yang sama dengan key yang sudah ada, jadi bedakan key dari karakter pertama dan terakhirnya serta tanggal Created. Key tidak kedaluwarsa: key berfungsi sampai Anda menghapusnya.

Batas#

Sebuah workspace dapat memiliki hingga 10 API key sekaligus. Saat mencapai batas, Anda melihat "You have reached the maximum limit of 10 API keys per organization." Hapus key yang tidak lagi Anda gunakan untuk membuat key baru.

Tabel API key#

Kolom	Arti
Label	Nama key, seperti API Key 1.
API Key	Karakter pertama dan terakhir dari key. Gunakan tombol salin untuk key lengkap.
Created	Tanggal key dibuat.
Status	Selalu Active. Key yang dihapus hilang dari tabel.
Actions	Delete menghapus key.

Menghapus API key#

Temukan key
Di Settings → API Keys, temukan key di tabel.
Hapus
Klik Delete, lalu Yes, Delete API Key.

Penghapusan key tidak dapat dibatalkan. Aplikasi apa pun yang masih menggunakannya langsung berhenti berfungsi dan menerima Auth Error: invalid api key. Perbarui aplikasi Anda dengan key baru terlebih dahulu.

WhatsApp Client ID#

Setiap nomor WhatsApp yang terhubung memiliki ID sendiri. Sebagian besar endpoint pesan memerlukannya di field whatsapp_client untuk memilih nomor mana yang mengirim pesan.

Buka WhatsApp settings dan lihat kolom Whatsapp Client ID di sebelah setiap nomor. Lihat Hubungkan nomor WhatsApp Anda jika Anda belum menghubungkan nomor.

Menguji kredensial#

Panggil Cek kredensial (POST /api/v1/me/) dengan client_id dan api_key Anda, serta whatsapp_client secara opsional. Endpoint ini memastikan kredensial berfungsi bersama tanpa mengirim apa pun atau memakai pesan. Jika whatsapp_client bukan milik workspace, responsnya adalah Invalid WhatsApp Client ID.

Jika API key bocor#

Siapa pun yang memiliki API key dan API Client ID Anda dapat mengirim pesan dari nomor WhatsApp Anda dan memakai kuota pesan workspace Anda.

Buat key pengganti
Di Settings → API Keys, klik Create New dan salin key baru.
Perbarui aplikasi Anda
Ganti key lama di setiap aplikasi dan integrasi yang menggunakannya.
Hapus key yang bocor
Klik Delete pada key yang bocor. Key tersebut langsung berhenti berfungsi.
Periksa penyalahgunaan
Tinjau pesan terbaru di Reports untuk menemukan pesan yang tidak Anda kirim.

Perlakukan juga email "WbizTool Alert - WhatsApp Connected Successfully!" sebagai rahasia: email ini dikirim ke pembuat workspace saat sebuah nomor pertama kali terhubung dan dapat berisi salah satu API key Anda.

Pemecahan masalah#

Masalah	Yang perlu diperiksa
Tab API Keys menampilkan No API Keys Found, padahal key ada	Anda bukan Administrator di workspace ini, atau workspace lain sedang dipilih.
"You don't have permission to create API keys in this space."	Hanya Administrator yang dapat membuat atau menghapus key. Tombol Generate New API Key di tabel kosong muncul untuk semua orang, tetapi hanya berfungsi untuk Administrator.
"You have reached the maximum limit of 10 API keys per organization."	Hapus key yang tidak lagi Anda gunakan.
`Auth Error: invalid api key`	Key sudah dihapus atau salah ketik, atau `client_id` bukan milik workspace yang sama dengan key. Jika key baru dan API Client ID yang ditampilkan di halaman tetap gagal, hubungi dukungan (workspace lama dapat menampilkan API Client ID yang hanya berfungsi dengan key yang dibuat oleh pembuat workspace).
`Auth Error - Please send correct API key and Client id`	`api_key` tidak ada dalam permintaan.
`Invalid client id.` (atau `Invalid Client Id` di beberapa endpoint)	`client_id` tidak ada atau bukan angka. Pada Cek kredensial, `client_id` atau `api_key` yang tidak ada hanya mengembalikan `Auth Error`; `Invalid Client Id` di sana berarti nilainya bukan angka. Salin dari kartu API Overview.
Permintaan bekerja pada workspace yang salah	Key dibuat di workspace lain. Beralihlah ke workspace yang benar dan buat key di sana.
`Demo Account can not access apis`	Akun demo tidak dapat menggunakan API. Daftar untuk akun gratis.