תחילת העבודה
ממשק API לבדיקת פרטי התחברות
השתמשו ב-API הזה כדי לאמת את פרטי ההתחברות שלכם לפני קריאות API אחרות. הוא מוודא שה-client_id וה-api_key שלכם עובדים יחד, ואם תרצו, גם שמזהה של מספר WhatsApp שייך לסביבת העבודה שלכם. הוא לא שולח דבר ולא צורך קרדיטים.
https://wbiztool.com/api/v1/me/גוף הבקשה: JSON או שדות טופס
דוגמה מהירה#
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
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/me/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678,
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result["status"] == 1:
print("Credentials OK for", result["name"])
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/me/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
whatsapp_client: 678,
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
console.log("Credentials OK for", result.name);
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'whatsapp_client' => 678,
];
$ch = curl_init('https://wbiztool.com/api/v1/me/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
echo 'Credentials OK for ' . $result['name'];
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}החליפו את 12345, YOUR_API_KEY ו-678 בערכים שלכם. השמיטו את whatsapp_client אם אתם רוצים לבדוק רק את המפתח. בסעיף אימות מוסבר איפה למצוא אותם.
פרמטרי הבקשה#
client_idintegerחובהמזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.
api_keystringחובהמפתח ה-API שלכם מאותו דף.
whatsapp_clientintegerאופציונליהמזהה של אחד ממספרי ה-WhatsApp שלכם, מהדף הגדרות WhatsApp. שלחו אותו כדי לבדוק גם שהמזהה שייך לסביבת העבודה של מפתח ה-API הזה. גם מספר שמחקתם ממרכז הבקרה עדיין עובר את הבדיקה הזו. הבדיקה היא של המזהה בלבד; היא לא אומרת לכם אם המספר מחובר. לשם כך השתמשו ב-סטטוס חיבור.
תגובה#
בקשה מוצלחת מחזירה HTTP 200:
{
"status": 1,
"message": "Okay",
"name": "[email protected] - 919876543210"
}
| שדה | סוג | תיאור |
|---|---|---|
status | integer | 1 אם פרטי ההתחברות תקינים, 0 אם לא. |
message | string | Okay בהצלחה, אחרת השגיאה. |
name | string | שם המשתמש של מי שיצר את סביבת העבודה. אם שלחתם whatsapp_client, מספר הטלפון של המספר מתווסף אחרי -. מופיע רק בהצלחה. |
שגיאות#
כל כישלון ב-endpoint הזה מחזיר HTTP 400, מלבד client_id שאינו מספרי, שמחזיר HTTP 403. בגוף התגובה status תמיד מוגדר ל-0:
{ "status": 0, "message": "Auth Error: invalid api key" }
| הודעה | איך לתקן |
|---|---|
Auth Error | שלחו גם client_id וגם api_key בגוף בקשת POST, כ-JSON תקין או כשדות טופס. ההודעה הזו מופיעה גם כש-whatsapp_client אינו מספר. |
Invalid Client Id | שלחו את client_id כמספר שלם, למשל 12345. |
Auth Error: invalid api key | ודאו שהמפתח קיים, לא נמחק ושייך ל-client_id הזה. |
Invalid WhatsApp Client ID | המזהה whatsapp_client הזה לא נמצא בסביבת העבודה של מפתח ה-API. העתיקו את המזהה מהדף הגדרות WhatsApp. |
בדיקה שה-API פעיל#
הנתיב /api/v1/status/ הוא בדיקת זמינות פשוטה. הוא לא דורש פרטי התחברות, מקבל כל מתודה ותמיד מחזיר:
{ "status": 200, "data": {} }
הוא רק אומר לכם שה-API נגיש. הוא לא בודק את פרטי ההתחברות שלכם ולא את החיבור של מספר ה-WhatsApp.
curl https://wbiztool.com/api/v1/status/
הפונקציה health_check() בלקוח ה-Python קוראת ל-endpoint הזה.
טיפים#
- בדקו פעם אחת בזמן ההגדרה: קראו ל-endpoint הזה כשמשתמש שומר את פרטי ההתחברות שלו באפליקציה שלכם, ולא לפני כל הודעה. בדיקה מוצלחת לא אומרת שאפשר לשלוח: היא לא בודקת כמה קרדיטים נותרו לכם או אם המספר שלכם מחובר.
- קראו את הגוף גם בשגיאות: כישלונות חוזרים כ-HTTP
400או403, אז ודאו שלקוח ה-HTTP שלכם עדיין מפענח את גוף ה-JSON. - מפתחות שנמחקו מפסיקים לעבוד מיד: אם מפתח נמחק בדף מפתחות ה-API, תקבלו
Auth Error: invalid api key. - השלב הבא: אחרי שפרטי ההתחברות עובדים, שלחו הודעה.
