انتقل إلى المحتوى
WbizTool

البدء

API التحقق من بيانات الاعتماد

استخدم هذا API للتحقق من بيانات الاعتماد قبل إجراء استدعاءات API أخرى. فهو يؤكد أن client_id وapi_key يعملان معًا، ويمكنه أيضًا التأكد من أن معرّف رقم WhatsApp ينتمي إلى مساحة العمل الخاصة بك. لا يرسل أي شيء ولا يُحتسب رسالة.

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

النص (Body): 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 إذا كنت تريد اختبار المفتاح فقط. راجع المصادقة لمعرفة مكان العثور عليها.

معاملات الطلب#

Authorizationheaderموصى به

‏Bearer YOUR_API_KEY: مفتاح API الخاص بك من Settings → API keys (الإعدادات ← مفاتيح API). مع الترويسة، يمكن حذف client_id وapi_key من الجسم؛ وإذا أُرسل المفتاح في الترويسة والجسم معًا، يُستخدم مفتاح الترويسة إذا كان صالحًا. راجع إرسال المفتاح في ترويسة.

client_idintegerبدون ترويسة Authorization

معرّف العميل في API ‏(API Client ID) من Settings → API keys. اختياري مع الترويسة؛ وإذا أرسلته، فيجب أن يكون لمساحة عمل المفتاح.

api_keystringبدون ترويسة Authorization

مفتاح API الخاص بك من الصفحة نفسها، عندما لا ترسله في الترويسة.

whatsapp_clientintegerاختياري

معرّف أحد أرقام WhatsApp الخاصة بك، من إعدادات WhatsApp. أرسله للتحقق أيضًا من أن المعرّف ينتمي إلى مساحة العمل الخاصة بمفتاح API هذا. الرقم الذي حذفته من لوحة التحكم يجتاز هذا الفحص أيضًا. فهو يتحقق من المعرّف فقط، ولا يخبرك ما إذا كان الرقم متصلًا. استخدم حالة الاتصال لذلك.

الاستجابة#

يُرجع الطلب الناجح HTTP 200:

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
الحقلالنوعالوصف
statusinteger‏1 إذا كانت بيانات الاعتماد صالحة، و0 إذا لم تكن كذلك.
messagestring‏Okay عند النجاح، وإلا نص الخطأ.
namestringاسم المستخدم للشخص الذي أنشأ مساحة العمل. إذا أرسلت whatsapp_client، يُضاف رقم هاتف ذلك الرقم بعد -. يظهر عند النجاح فقط.

الأخطاء#

كل حالة فشل في نقطة النهاية هذه تُرجع HTTP 400 (يحصل طلب GET على 405، والخطأ الداخلي على 500). ويحتوي الجسم دائمًا على status بقيمة 0:

{ "status": 0, "message": "Auth Error: invalid api key" }
الرسالةطريقة الإصلاح
Auth Error - Please send correct API key and Client idأرسل client_id وapi_key كليهما في جسم طلب POST، بصيغة JSON صالحة أو كحقول نموذج.
Invalid client id.أرسل client_id كعدد، مثل 12345.
Auth Error: invalid api keyتأكد من أن المفتاح موجود، ولم يُحذف، وينتمي إلى client_id هذا: أي Client ID الظاهر في تبويب مفاتيح API.
This API key is not linked to a workspace. Create a new API key in WbizTool.المفتاح من إعداد حساب قديم. أنشئ مفتاحًا جديدًا في تبويب مفاتيح API.
Invalid WhatsApp Client IDقيمة whatsapp_client هذه ليست عددًا، أو لا تخص رقمًا في مساحة العمل الخاصة بهذا المفتاح. انسخ المعرّف … ⧉ الخاص به من أرقام WhatsApp.
Method not allowed, use POSTأرسل طلب POST ‏(HTTP 405).

التحقق من أن API يعمل#

‏/api/v1/status/ فحص تشغيل بسيط. لا يحتاج إلى بيانات اعتماد، ويقبل أي طريقة، ويُرجع دائمًا:

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

يخبرك فقط بأن API قابل للوصول. ولا يتحقق من بيانات الاعتماد أو من اتصال رقم WhatsApp الخاص بك.

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

تستدعي الدالة health_check() في مكتبة Python نقطة النهاية هذه.

نصائح#

  • تحقّق مرة واحدة عند الإعداد: استدعِ نقطة النهاية هذه عندما يحفظ المستخدم بيانات اعتماده في تطبيقك، بدلًا من استدعائها قبل كل رسالة. نجاح الفحص لا يعني أنك تستطيع الإرسال: فهو لا ينظر إلى رسائل باقتك ولا إلى اتصال رقمك.
  • اقرأ الجسم عند الأخطاء: تعود حالات الفشل برمز HTTP 400، لذا تأكد من أن عميل HTTP لديك يحلّل جسم JSON رغم ذلك.
  • تتوقف المفاتيح المحذوفة عن العمل فورًا: إذا حُذف مفتاح من صفحة مفاتيح API، فستحصل على Auth Error: invalid api key.
  • الخطوة التالية: بعد أن تعمل بيانات الاعتماد، أرسل رسالة.