דלגו לתוכן
Wbiztool

תחילת העבודה

ממשק API לבדיקת פרטי התחברות

השתמשו ב-API הזה כדי לאמת את פרטי ההתחברות שלכם לפני קריאות API אחרות. הוא מוודא שה-client_id וה-api_key שלכם עובדים יחד, ואם תרצו, גם שמזהה של מספר WhatsApp שייך לסביבת העבודה שלכם. הוא לא שולח דבר ולא צורך קרדיטים.

POSThttps://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
  }'

החליפו את 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"
}
שדהסוגתיאור
statusinteger1 אם פרטי ההתחברות תקינים, 0 אם לא.
messagestringOkay בהצלחה, אחרת השגיאה.
namestringשם המשתמש של מי שיצר את סביבת העבודה. אם שלחתם 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.
  • השלב הבא: אחרי שפרטי ההתחברות עובדים, שלחו הודעה.