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 memakai kredit.

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 key. Lihat Autentikasi untuk mengetahui di mana menemukannya.

Parameter request#

client_idintegerwajib

API Client ID Anda dari Settings → API keys (Pengaturan → Kunci API).

api_keystringwajib

API key Anda dari halaman yang sama.

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 API key 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, kecuali client_id yang bukan angka, yang mengembalikan HTTP 403. Body selalu berisi status bernilai 0:

{ "status": 0, "message": "Auth Error: invalid api key" }
PesanCara memperbaikinya
Auth ErrorKirim client_id dan api_key di body POST, sebagai JSON atau field formulir yang valid. Pesan ini juga muncul jika whatsapp_client bukan angka.
Invalid Client IdKirim client_id sebagai bilangan bulat, misalnya 12345.
Auth Error: invalid api keyPastikan key tersebut ada, belum dihapus, dan milik client_id ini.
Invalid WhatsApp Client IDID whatsapp_client tersebut tidak ada di workspace API key ini. Salin ID dari WhatsApp settings.

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 sisa kredit Anda atau apakah nomor Anda terhubung.
  • Baca body saat terjadi error: kegagalan dikembalikan sebagai HTTP 400 atau 403, jadi pastikan HTTP client Anda tetap mem-parse body JSON.
  • Key yang dihapus langsung berhenti berfungsi: jika sebuah key dihapus di halaman API keys, Anda akan mendapatkan Auth Error: invalid api key.
  • Langkah berikutnya: setelah kredensial Anda berfungsi, kirim pesan.