Panduan produk

Kunci API

Untuk menggunakan API Wbiztool, atau integrasi yang meminta kelayakan anda, anda memerlukan tiga perkara daripada papan pemuka:

Kelayakan	Medan API	Di mana untuk mencarinya
API Client ID	`client_id`	Settings → API Keys, di bahagian atas halaman
Kunci API	`api_key`	Settings → API Keys
WhatsApp Client ID	`whatsapp_client`	Lajur Whatsapp Client ID di WhatsApp settings

Sebelum anda bermula#

Anda mesti menjadi Administrator (Pentadbir) ruang kerja untuk melihat, mencipta atau memadam kunci API. Lihat Peranan dan kebenaran.
Pilih ruang kerja yang betul terlebih dahulu. Kunci tergolong dalam ruang kerja yang dipilih semasa anda menciptanya, dan permintaan API yang dibuat dengan sesuatu kunci bertindak ke atas ruang kerja itu. Lihat Tukar ruang kerja.
Akaun demo tidak boleh menggunakan API.

Cari API Client ID anda#

Buka Settings → API Keys. Kad API Overview menunjukkan API Client ID: diikuti nombor. Gunakan nombor ini sebagai client_id dalam setiap permintaan. Ia sama bagi setiap kunci dalam ruang kerja.

Cipta kunci API#

Buka API Keys
Pergi ke Settings dan klik tab API Keys, atau buka /settings/?tab=api-keys secara terus.
Cipta kunci
Di bawah New API Key, klik Create New. Mesej kejayaan mengesahkan kunci telah dijana, dan ia muncul dalam jadual.
Salin kunci penuh
Lajur API Key hanya menunjukkan permulaan dan penghujung setiap kunci. Klik butang salin di sebelahnya (Copy Full API Key) untuk menyalin kunci penuh, kemudian tampalkannya ke dalam aplikasi atau integrasi anda.

Kunci dinamakan secara automatik berdasarkan bilangan kunci yang dimiliki ruang kerja (API Key 1, API Key 2 dan seterusnya) dan tidak boleh dinamakan semula. Selepas anda memadam kunci, kunci baharu boleh mendapat nama yang sama dengan kunci sedia ada, jadi bezakan kunci melalui aksara pertama dan terakhirnya serta tarikh Created. Kunci tidak tamat tempoh: kunci berfungsi sehingga anda memadamnya.

Had#

Sesebuah ruang kerja boleh mempunyai sehingga 10 kunci API pada satu masa. Apabila anda mencapai had itu, anda melihat "You have reached the maximum limit of 10 API keys per organization." Padam kunci yang tidak lagi digunakan untuk mencipta kunci baharu.

Jadual kunci API#

Lajur	Maksud
Label	Nama kunci, seperti API Key 1.
API Key	Aksara pertama dan terakhir kunci. Gunakan butang salin untuk kunci penuh.
Created	Tarikh kunci dicipta.
Status	Sentiasa Active. Kunci yang dipadam dialih keluar daripada jadual.
Actions	Delete mengalih keluar kunci.

Padam kunci API#

Cari kunci
Di Settings → API Keys, cari kunci itu dalam jadual.
Padamkannya
Klik Delete, kemudian Yes, Delete API Key.

Pemadaman kunci tidak boleh dibuat asal. Sebarang aplikasi yang masih menggunakannya berhenti berfungsi serta-merta dan menerima Auth Error: invalid api key. Kemas kini aplikasi anda dengan kunci baharu terlebih dahulu.

WhatsApp Client ID#

Setiap nombor WhatsApp yang disambungkan mempunyai ID sendiri. Kebanyakan endpoint mesej memerlukannya dalam medan whatsapp_client untuk memilih nombor yang menghantar mesej.

Buka WhatsApp settings dan baca lajur Whatsapp Client ID di sebelah setiap nombor. Lihat Sambung nombor WhatsApp anda jika anda belum menyambung nombor.

Uji kelayakan anda#

Panggil Semak kelayakan (POST /api/v1/me/) dengan client_id dan api_key anda, dan secara pilihan whatsapp_client. Ia mengesahkan bahawa semuanya berfungsi bersama tanpa menghantar apa-apa atau menggunakan sebarang mesej. Jika whatsapp_client bukan milik ruang kerja itu, responsnya ialah Invalid WhatsApp Client ID.

Jika kunci API terdedah#

Sesiapa yang mempunyai kunci API dan API Client ID anda boleh menghantar mesej dari nombor WhatsApp anda dan menggunakan mesej ruang kerja anda.

Cipta kunci pengganti
Di Settings → API Keys, klik Create New dan salin kunci baharu.
Kemas kini aplikasi anda
Gantikan kunci lama dalam setiap aplikasi dan integrasi yang menggunakannya.
Padam kunci yang terdedah
Klik Delete pada kunci yang terdedah. Ia berhenti berfungsi serta-merta.
Semak penyalahgunaan
Semak mesej terkini di Reports (Laporan) untuk apa-apa yang bukan dihantar oleh anda.

Anggap juga e-mel "WbizTool Alert - WhatsApp Connected Successfully!" sebagai rahsia: ia dihantar kepada pencipta ruang kerja apabila nombor bersambung buat kali pertama dan boleh mengandungi salah satu kunci API anda.

Penyelesaian masalah#

Masalah	Perkara yang perlu disemak
Tab API Keys menunjukkan No API Keys Found, tetapi kunci wujud	Anda bukan Administrator dalam ruang kerja ini, atau ruang kerja lain dipilih.
"You don't have permission to create API keys in this space."	Hanya Administrator boleh mencipta atau memadam kunci. Butang Generate New API Key dalam jadual kosong muncul untuk semua orang, tetapi hanya berfungsi untuk Administrator.
"You have reached the maximum limit of 10 API keys per organization."	Padam kunci yang tidak lagi digunakan.
`Auth Error: invalid api key`	Kunci itu telah dipadam atau tersalah taip, atau `client_id` bukan milik ruang kerja yang sama dengan kunci. Jika kunci baharu dan API Client ID yang ditunjukkan di halaman masih gagal, hubungi sokongan (ruang kerja yang lebih lama boleh menunjukkan API Client ID yang hanya berfungsi dengan kunci yang dicipta oleh pencipta ruang kerja).
`Auth Error - Please send correct API key and Client id`	`api_key` tiada dalam permintaan.
`Invalid client id.` (atau `Invalid Client Id` pada sesetengah endpoint)	`client_id` tiada atau bukan nombor. Pada Semak kelayakan, `client_id` atau `api_key` yang tiada hanya memulangkan `Auth Error`; `Invalid Client Id` di sana bermaksud ia bukan nombor. Salinnya daripada kad API Overview.
Permintaan bertindak ke atas ruang kerja yang salah	Kunci itu dicipta dalam ruang kerja lain. Tukar ruang kerja dan cipta kunci di sana.
`Demo Account can not access apis`	Akaun demo tidak boleh menggunakan API. Daftar untuk akaun percuma.