Panduan produk
Kunci API dan Client ID
Kunci API membolehkan perisian anda sendiri, serta alat seperti Zapier, n8n, Make dan pemalam WordPress, menghantar mesej WhatsApp dari nombor ruang kerja anda. Kod anda sendiri menghantar kunci dalam pengepala Authorization: Bearer; integrasi meminta dua nilai dari halaman Kunci API: Client ID ruang kerja anda dan salah satu kuncinya. Halaman yang sama mempunyai rahsia yang menandatangani webhook kami.
Siapa yang boleh melakukannya: Pemilik sahaja – setiap Pemilik ruang kerja, bukan hanya penciptanya. Pemilik melihat, mencipta, menyalin dan memadam semua kunci ruang kerja, tidak kira siapa yang menciptanya. Editor dan Penganalisis tidak melihat Kunci API dalam bar sisi atau di halaman Tetapan, dan pautan ke halaman itu membuka Profil untuk mereka (lihat Peranan dan kebenaran). Kunci berfungsi pada setiap pelan, termasuk percubaan percuma; apa yang anda hantar dengannya menggunakan mesej ruang kerja.
Buka Kunci API di bawah Integrasi dalam bar sisi, atau pergi ke Tetapan → Kunci API.
Setiap kunci menunjukkan namanya, bila ia Dicipta, empat aksara terakhir kunci (seperti •••• 7f3a), Salin kunci dan Padam. Kunci terbaharu berada di atas.
Cipta kunci API#
Klik Cipta kunci
Di Tetapan → Kunci API, klik Cipta kunci di bahagian atas sebelah kanan kad.
Namakannya (pilihan)
Di bawah Nama (pilihan), taip aplikasi yang akan menggunakannya, seperti
n8natauLaman web(sehingga 50 aksara). Jika dibiarkan kosong, ia diberi nama seperti "API Key 3", seperti yang dinyatakan oleh petunjuk di bawah medan.Ciptakannya
Salin kunci
- Sehingga 10 kunci bagi setiap ruang kerja. Dengan 10 kunci, Cipta kunci berwarna kelabu, dan apabila anda menghalakan tetikus padanya, ia menunjukkan "Anda boleh mempunyai sehingga 10 kunci API. Padam satu untuk mencipta yang lain."
- Kunci tidak tamat tempoh, dan ia tidak boleh dinamakan semula atau dimatikan: kunci berfungsi sehingga ia dipadam.
- Satu kunci bagi setiap aplikasi. Namakan setiap kunci mengikut aplikasi yang menggunakannya, supaya anda boleh mengganti atau memadam satu kunci tanpa merosakkan yang lain.
- Ruang kerja yang mana: kunci tergolong dalam ruang kerja yang dipilih semasa anda menciptanya, dan setiap permintaan yang dibuat dengannya bertindak pada ruang kerja itu: nombor, mesej dan pelannya. Untuk menghantar dari ruang kerja lain, tukar kepadanya dan cipta kunci di sana.
Apa yang perlu dimasukkan dalam aplikasi anda#
| Medan API | Nama dalam integrasi | Tempat mencarinya |
|---|---|---|
client_id | Client ID | Baris Client ID di bahagian atas kad Kunci API. Salin di sebelahnya menyalinnya ("Client ID disalin."). Ia sama bagi setiap kunci dalam ruang kerja. |
api_key | Kunci API | Kunci yang anda salin: 40 aksara, digit dan huruf a hingga f. |
whatsapp_client | WhatsApp Client ID | ID nombor, seperti ID 101 ⧉ pada kadnya di Nombor WhatsApp: klik untuk menyalinnya, atau senaraikan setiap nombor dengan API Senarai Akaun WhatsApp. Ia menentukan nombor yang menghantar. Lihat Halaman Nombor WhatsApp. |
Tempat ia dimasukkan:
- Kod anda sendiri: dalam pengepala
Authorization: Bearer YOUR_API_KEYpada setiap permintaan (disyorkan). Kunci menentukan ruang kerjanya, jadiclient_idboleh ditinggalkan; jika anda menghantarnya, ia mesti tetap Client ID ruang kerja ini. Lihat Hantar kunci dalam pengepala, dan Hantar mesej untuk mesej pertama dalam cURL, Python, Node.js dan PHP. - Zapier: Client ID dan kunci API semasa anda menyambungkan akaun anda.
- n8n: Client ID, API Key dan WhatsApp Client ID dalam kelayakan WbizTool.
- Make, Pabbly Connect dan alat lain: badan permintaan HTTP.
- WordPress: WbizTool → Settings, di bawah API Configuration.
Google Sheets dan Shopify disediakan dalam papan pemuka dan tidak memerlukan kunci.
Hantar kunci dalam pengepala#
Setiap endpoint /api/v1/ menerima kunci dalam pengepala Authorization, sama seperti API v2 yang akan datang:
Authorization: Bearer YOUR_API_KEY
client_idadalah pilihan dengan pengepala: kunci yang menentukan ruang kerja. Jika anda juga menghantarclient_id, ia mestilah Client ID ruang kerja ini, seperti sebelum ini.- Hantar kunci di satu tempat sahaja. Dengan pengepala, tinggalkan
api_keydaripada badan, atau hantar kunci yang sama. Jika kedua-duanya berbeza, kunci dalam pengepala digunakan apabila ia kunci yang sah; jika pengepala mengandungi sesuatu yang lain (contohnya token alat lain),api_keydalam badan yang digunakan. - Kunci dalam badan masih berfungsi (
client_iddanapi_keysebagai JSON atau medan borang), jadi tiada apa-apa yang berubah bagi aplikasi dan integrasi yang menghantarnya. Pengepala lebih baik kerana badan permintaan lebih kerap tersimpan dalam log, proksi dan sejarah pembina borang berbanding pengepala. - Medan borang, muat naik multipart dan badan JSON semuanya berfungsi dengan pengepala.
curl -X POST https://wbiztool.com/api/v1/send_msg/ \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"whatsapp_client": 101, "phone": "919876543210", "msg": "Hello from WbizTool"}'
Uji kunci anda#
Panggil Semak kelayakan (POST /api/v1/me/) dengan kunci anda dan, jika mahu, whatsapp_client. "status": 1 dengan "message": "Okay" bermaksud semuanya berfungsi bersama. Ia tidak menghantar apa-apa dan tidak menggunakan mesej, tetapi ia tidak menyemak sama ada anda masih mempunyai baki mesej atau sama ada nombor itu disambungkan.
curl -X POST https://wbiztool.com/api/v1/me/ -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" -d '{"whatsapp_client": 101}'
Kunci yang berfungsi menjawab {"status": 1, "message": "Okay", "name": "…"}.
Salin kunci sekali lagi#
Klik Salin kunci di sebelah kunci. Kunci penuh masuk ke papan keratan anda tanpa dipaparkan di halaman; anda melihat, contohnya, "“Zapier” disalin." dan butang itu menunjukkan Disalin ✓ seketika. Anda tidak memerlukan kunci baharu hanya kerana anda kehilangan kunci lama.
Untuk mengetahui kunci yang digunakan oleh sesuatu aplikasi, bandingkan empat aksara terakhir kuncinya dengan senarai.
Padam kunci#
Klik Padam
Klik Padam di sebelah kunci.
Sahkan
Dialog "Padam “…”?" memberi amaran: "Apa-apa yang menggunakan kunci ini berhenti berfungsi serta-merta: Zap dalam Zapier, senario n8n dan Make, pemalam WordPress dan panggilan API anda sendiri. Berikan kunci lain kepadanya dahulu. Tindakan ini tidak boleh dibatalkan." Klik Padam kunci. Anda melihat "“…” dipadam."
Mulai saat itu, permintaan dengan kunci itu mendapat Auth Error: invalid api key. Apa yang telah dilakukannya sebelum itu kekal: mesej yang telah dimasukkannya ke baris gilir tetap dihantar (batalkannya dalam Laporan jika perlu), dan peringatan yang diciptanya terus berjalan. Pencetus Zapier Incoming WhatsApp Message yang disediakan dengannya juga terus menerima mesej, kerana webhooknya sudah berada pada nombor itu: matikan Zap dalam Zapier untuk menghentikannya.
Ganti kunci#
Ganti kunci apabila ia mungkin terdedah, apabila seseorang yang boleh menyalinnya pergi, atau dari semasa ke semasa. Tiada butang putaran: cipta kunci baharu dahulu, supaya tiada apa-apa yang terhenti di antaranya.
Cipta kunci baharu
Cipta kunci dan salinnya. Jika sudah ada 10 kunci, padam dahulu satu yang tidak lagi anda gunakan.
Kemas kini aplikasi anda
Tampal kunci baharu ke dalam setiap aplikasi dan integrasi yang menggunakan kunci lama, dan semak setiap satu, contohnya dengan Semak kelayakan.
Padam kunci lama
Padamkannya. Ia berhenti berfungsi serta-merta.
Semak penyalahgunaan (selepas kebocoran)
Lihat Laporan untuk mesej yang tidak anda hantar dan batalkan mana-mana yang masih menunggu. Di Peringatan, padam peringatan yang tidak anda cipta, kerana ia terus berjalan. Alih keluar nombor yang tidak anda tambah di Nombor WhatsApp. Dengan tambahan Unibox, semak Nombor peti masuk untuk lencana Zapier atau webhook yang tidak anda kenali.
Pastikan kunci anda selamat#
Kunci tidak mempunyai kebenarannya sendiri: sesiapa yang memilikinya boleh melakukan semua yang boleh dilakukan oleh API dalam ruang kerja anda, apa pun peranannya. Ini termasuk menghantar mesej dari mana-mana nombornya (menggunakan mesejnya), membaca sejarah mesejnya, membatalkan mesej yang menunggu, mengurus peringatan dan fail media, menyemak nombor dan menyambungkan nombor baharu.
- Simpan kunci pada pelayan anda, dalam pemboleh ubah persekitaran atau stor kelayakan integrasi anda. Jangan sekali-kali meletakkannya dalam JavaScript laman web, aplikasi mudah alih, hamparan yang dikongsi atau kod yang anda terbitkan.
- Jangan hantar kunci melalui e-mel atau sembang. Tampalkannya terus ke dalam aplikasi yang memerlukannya.
- Gunakan satu kunci bagi setiap aplikasi, dan padam kunci yang tidak lagi anda gunakan.
- Ganti kunci dari semasa ke semasa, dan serta-merta jika ada kunci yang mungkin terdedah.
Client ID sahaja bukan rahsia, tetapi layan setiap kunci seperti kata laluan.
Kunci API v2#
API v2 mempunyai kuncinya sendiri, yang dicipta dalam kad Kunci API v2 pada tab yang sama. Kunci ini lebih selamat daripada kunci di atas:
- Dipaparkan sekali. Kunci penuh (
wbz_live_…) hanya dipaparkan semasa anda menciptanya; WbizTool hanya menyimpan cap jarinya. Jika hilang, tarik baliknya dan cipta yang baharu. - Hanya apa yang diperlukan. Tandakan apa yang boleh dilakukan oleh kunci (menghantar mesej, membaca mesej, peringatan, nombor, media, semakan nombor), hadkannya kepada sebahagian nombor anda, dan berikan tarikh tamat tempoh jika anda mahu.
- Kunci ujian. Kunci ujian (
wbz_test_…) menyemak setiap permintaan seperti kunci langsung tetapi tidak menghantar apa-apa – untuk membina dan mencuba integrasi. - Kali terakhir digunakan. Setiap kunci menunjukkan bila dan dari mana ia kali terakhir digunakan. Tarik balik menghentikannya serta-merta, bersama endpoint webhook yang disediakan dengannya.
Kunci di atas hanya berfungsi dengan API v1, dan kunci API v2 hanya dengan v2. Lihat Berpindah dari v1 ke v2.
Tandatangan webhook#
WbizTool menandatangani setiap webhook yang dihantar kepada anda, supaya endpoint anda boleh memastikan permintaan itu benar-benar datang daripada kami dan tidak diubah dalam perjalanan: webhook status mesej (dihantar, gagal, dibatalkan, tamat tempoh), peristiwa sambungan nombor dan webhook peti masuk. Badannya sama seperti sebelum ini; dua pengepala ditambah:
| Pengepala | Nilai |
|---|---|
WbizTool-Timestamp | Masa kami menghantarnya, dalam saat Unix, seperti 1792310400 |
WbizTool-Signature | v1= dan HMAC-SHA256 heks bagi <timestamp>.<raw body>, dibuat dengan rahsia tandatangan ruang kerja anda |
Tandatangan meliputi bait tepat yang kami hantar: medan borang seperti yang diterima, keseluruhan badan multipart apabila imej kod QR dilampirkan, dan JSON webhook peti masuk. Penerima yang mengabaikan pengepala ini terus berfungsi.
Dapatkan rahsia tandatangan#
Di Tetapan → Kunci API, kad Rahsia tandatangan webhook di bawah kunci anda menunjukkan empat aksara terakhir rahsia, seperti •••• b70d. Setiap ruang kerja mempunyai satu rahsia untuk semua webhooknya; ia dicipta bersama webhook pertama yang kami hantar kepada anda.
Klik Paparkan rahsia baharu
Klik Paparkan rahsia baharu (atau Cipta rahsia jika ruang kerja belum mempunyainya). Dialog "Gantikan rahsia tandatangan?" memberi amaran bahawa rahsia semasa berhenti berfungsi serta-merta. Klik Jana rahsia baharu.
Salinnya
Rahsia tandatangan webhook anda menunjukkan rahsia penuh sekali sahaja. Klik Salin dan simpan di tempat yang boleh dibaca oleh penerima webhook anda, seperti pemboleh ubah persekitaran. Anda tidak akan melihatnya lagi: jika hilang, jana yang baharu.
Hanya Pemilik yang melihat kad ini. Menjana rahsia baharu menggantikan yang lama serta-merta, jadi kemas kini penerima anda sejurus selepas itu; webhook yang dihantar di antaranya gagal dalam semakan anda.
Semak webhook#
Kira tandatangan daripada badan mentah (sebelum rangka kerja anda menghuraikannya), bandingkan dengan pengepala dalam masa malar, dan tolak cap masa yang lebih lama daripada 5 minit supaya permintaan lama tidak boleh dimainkan semula:
import hashlib, hmac, time
def verify(secret: str, body: bytes, headers) -> bool:
ts, sig = headers["WbizTool-Timestamp"], headers["WbizTool-Signature"]
mac = "v1=" + hmac.new(secret.encode(), ts.encode() + b"." + body, hashlib.sha256).hexdigest()
return abs(time.time() - int(ts)) < 300 and hmac.compare_digest(mac, sig)Dalam Django, hantar request.body dan request.headers; dalam Flask, request.get_data() dan request.headers.
const crypto = require("crypto");
function verify(secret, rawBody, headers) {
const ts = headers["wbiztool-timestamp"], sig = String(headers["wbiztool-signature"]);
const mac = "v1=" + crypto.createHmac("sha256", secret).update(ts + ".").update(rawBody).digest("hex");
return Math.abs(Date.now() / 1000 - Number(ts)) < 300 && sig.length === mac.length &&
crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(mac));
}rawBody ialah badan sebagai Buffer: dalam Express, gunakan express.raw({ type: "*/*" }) pada laluan webhook dan bukannya penghurai JSON atau borang.
Jawab 2xx apabila semakan lulus dan 401 apabila ia gagal. Webhook peti masuk yang mempunyai rahsia webhook sendiri pada nombornya tetap juga membawa X-Wbiztool-Signature; WbizTool-Signature ialah skema yang sama pada setiap webhook.
Penyelesaian masalah#
| Mesej atau masalah | Apa yang perlu dilakukan |
|---|---|
| Tiada Kunci API dalam bar sisi atau di halaman Tetapan | Anda ialah Editor atau Penganalisis dalam ruang kerja ini. Minta kunci daripada Pemilik, atau minta dijadikan Pemilik. |
| Cipta kunci berwarna kelabu | Ruang kerja mempunyai 10 kunci. Padam satu yang tidak lagi anda gunakan. |
| "Tidak dapat menyalin – pelayar anda menyekat papan keratan. Cuba lagi." | Benarkan akses papan keratan untuk wbiztool.com dalam pelayar anda, atau cuba pelayar lain. Dalam Kunci API baharu anda, anda juga boleh memilih kunci dan menyalinnya sendiri. |
| "Tidak dapat mendapatkan kunci. Cuba lagi." | Muat semula halaman dan klik Salin kunci sekali lagi. |
| "Kunci itu telah pun dipadam." | Pemilik lain telah memadamnya sementara itu. Senarai menunjukkan kunci yang tinggal. |
| Kunci menunjukkan Tidak aktif | Ia tidak berfungsi. Padamkannya dan cipta kunci baharu. |
Auth Error: invalid api key | Kunci telah dipadam atau tersalah taip (salin semula, tanpa ruang), atau client_id bukan Client ID ruang kerja ini. |
Auth Error - Please send correct API key and Client id | api_key tiada atau kosong. |
| Webhook gagal dalam semakan tandatangan anda | Semak berdasarkan badan mentah, bukan medan yang telah dihuraikan dan dikodkan semula; gunakan rahsia semasa (selepas Paparkan rahsia baharu hanya yang baharu berfungsi); dan semak jam pelayan anda (cap masa yang berbeza lebih daripada 5 minit ditolak). |
Auth Error | client_id atau api_key tiada, badan bukan JSON atau medan borang, atau permintaan bukan POST, pada endpoint seperti Hantar ke banyak nombor, Jadualkan mesej dan Status mesej. |
Invalid client id., Invalid Client Id, client_id is required atau client_id must be a valid integer | client_id tiada atau bukan nombor seperti 5012. Salinnya dari baris Client ID. |
Invalid WhatsApp Client ID (Semak kelayakan) atau Invalid whatsapp client … (Hantar mesej) | ID nombor tiada dalam ruang kerja kunci ini, atau nombor itu telah dialih keluar. Salin ID … ⧉ dari Nombor WhatsApp. |
| E-mel "Tiada mesej daripada … selama 2 hari" | Ruang kerja anda biasanya menghantar melalui API atau integrasi setiap hari dan tiada apa-apa yang masuk selama 2 hari. E-mel itu menamakan mana-mana kunci yang dicipta atau dipadam dalam minggu lalu: pastikan aplikasi itu masih mempunyai kunci yang berfungsi (lihat Pemberitahuan). |
Invalid API key atau Invalid client_id for this API key | API pengesahan nombor atau API media: kunci salah atau telah dipadam, atau client_id bukan milik ruang kerja kunci itu. |
This API key is not linked to a workspace. Create a new API key in WbizTool. | Kunci itu berasal daripada persediaan akaun lama. Cipta kunci baharu dan gunakannya. |
Only workspace owners and editors can connect Zapier triggers | Kunci itu dicipta oleh seseorang yang bukan lagi Pemilik atau Editor. Cipta kunci baharu dan sambungkan semula Zapier. |
Demo Account can not access apis | Akaun demo tidak boleh menggunakan API. Daftar untuk akaun anda sendiri. |
Not enough credits | Kunci berfungsi, tetapi ruang kerja menggunakan pelan percuma dan tiada baki mesej. Lihat Pelan dan bil. |
| Permintaan bertindak pada ruang kerja yang salah | Kunci itu dicipta dalam ruang kerja lain. Tukar ruang kerja dan cipta kunci di sana. |



