Langsung ke konten
WbizTool

Memulai

API Cek kredensial

Gunakan API ini untuk memvalidasi kredensial Anda sebelum melakukan panggilan API lainnya. API ini memastikan bahwa client_id dan api_key Anda cocok satu sama lain dan, secara opsional, bahwa sebuah ID nomor WhatsApp termasuk dalam workspace Anda. API ini tidak mengirim apa pun dan tidak dihitung sebagai pesan.

POSThttps://wbiztool.com/api/v1/me/

Body: JSON atau field formulir

Contoh singkat#

curl -X POST https://wbiztool.com/api/v1/me/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

Ganti 12345, YOUR_API_KEY, dan 678 dengan nilai Anda sendiri. Hilangkan whatsapp_client jika Anda hanya ingin menguji kunci. Lihat Autentikasi untuk mengetahui di mana menemukannya.

Parameter request#

AuthorizationheaderDisarankan

Bearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini, client_id dan api_key boleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.

client_idintegerTanpa header Authorization

API Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.

api_keystringTanpa header Authorization

Kunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header.

whatsapp_clientintegeropsional

ID salah satu nomor WhatsApp Anda, dari WhatsApp settings (pengaturan WhatsApp). Kirim parameter ini untuk sekaligus memeriksa bahwa ID tersebut termasuk dalam workspace kunci API ini. Nomor yang sudah Anda hapus dari dashboard tetap lolos pemeriksaan ini. Pemeriksaan ini hanya mengecek ID; tidak memberi tahu apakah nomor tersebut terhubung. Gunakan Status koneksi untuk itu.

Respons#

Request yang berhasil mengembalikan HTTP 200:

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
FieldTipeDeskripsi
statusinteger1 jika kredensial valid, 0 jika tidak.
messagestringOkay jika berhasil, selain itu berisi error.
namestringUsername orang yang membuat workspace. Jika Anda mengirim whatsapp_client, nomor telepon dari nomor tersebut ditambahkan setelah -. Hanya ada jika berhasil.

Error#

Setiap kegagalan di endpoint ini mengembalikan HTTP 400 (request GET mendapat 405, error internal 500). Body selalu berisi status bernilai 0:

{ "status": 0, "message": "Auth Error: invalid api key" }
PesanCara memperbaikinya
Auth Error - Please send correct API key and Client idKirim client_id dan api_key di body POST, sebagai JSON atau field formulir yang valid.
Invalid client id.Kirim client_id sebagai angka, misalnya 12345.
Auth Error: invalid api keyPastikan kunci tersebut ada, belum dihapus, dan milik client_id ini: Client ID di tab Kunci API.
This API key is not linked to a workspace. Create a new API key in WbizTool.Kunci berasal dari penyiapan akun lama. Buat kunci baru di tab Kunci API.
Invalid WhatsApp Client IDwhatsapp_client tersebut bukan angka, atau bukan nomor di workspace kunci ini. Salin ID … ⧉ nomor itu dari Nomor WhatsApp.
Method not allowed, use POSTKirim request POST (HTTP 405).

Memeriksa apakah API aktif#

/api/v1/status/ adalah pemeriksaan ketersediaan (liveness check) sederhana. Endpoint ini tidak memerlukan kredensial, menerima metode apa pun, dan selalu mengembalikan:

{ "status": 200, "data": {} }

Endpoint ini hanya memberi tahu bahwa API dapat dijangkau. Endpoint ini tidak memeriksa kredensial Anda atau apakah nomor WhatsApp Anda terhubung.

curl https://wbiztool.com/api/v1/status/

health_check() di klien Python memanggil endpoint ini.

Tips#

  • Cek sekali saat penyiapan: panggil endpoint ini ketika pengguna menyimpan kredensialnya di aplikasi Anda, bukan sebelum setiap pesan. Pemeriksaan yang berhasil tidak berarti Anda bisa mengirim: endpoint ini tidak memeriksa pesan paket Anda atau apakah nomor Anda terhubung.
  • Baca body saat terjadi error: kegagalan dikembalikan sebagai HTTP 400, jadi pastikan HTTP client Anda tetap mem-parse body JSON.
  • Kunci yang dihapus langsung berhenti berfungsi: jika sebuah kunci dihapus di halaman Kunci API, Anda akan mendapatkan Auth Error: invalid api key.
  • Langkah berikutnya: setelah kredensial Anda berfungsi, kirim pesan.