أدلة المنتج
مفاتيح API
لاستخدام Wbiztool API، أو أي تكامل يطلب بيانات اعتمادك، تحتاج إلى ثلاثة أشياء من لوحة التحكم:
| بيانات الاعتماد | حقل API | أين تجدها |
|---|---|---|
| API Client ID (معرّف عميل API) | client_id | Settings → API Keys (الإعدادات ← مفاتيح API)، أعلى الصفحة |
| مفتاح API | api_key | Settings → API Keys |
| WhatsApp Client ID (معرّف عميل WhatsApp) | whatsapp_client | العمود Whatsapp Client ID في صفحة WhatsApp settings (إعدادات WhatsApp) |
قبل أن تبدأ#
- يجب أن تكون Administrator (مسؤولًا) في مساحة العمل لترى مفاتيح API أو تنشئها أو تحذفها. راجع الأدوار والصلاحيات.
- اختر مساحة العمل الصحيحة أولًا. تنتمي المفاتيح إلى مساحة العمل المحددة عند إنشائها، والطلبات المرسلة إلى API بمفتاح ما تعمل على تلك المساحة. راجع التبديل بين مساحات العمل.
- لا يمكن للحسابات التجريبية (Demo) استخدام API.
اعثر على معرّف عميل API#
افتح Settings → API Keys. تعرض بطاقة API Overview (نظرة عامة على API) العبارة API Client ID: متبوعة برقم. استخدم هذا الرقم بوصفه client_id في كل طلب. وهو نفسه لكل المفاتيح في مساحة العمل.
أنشئ مفتاح API#
افتح مفاتيح API
انتقل إلى Settings (الإعدادات) وانقر على تبويب API Keys (مفاتيح API)، أو افتح /settings/?tab=api-keys مباشرة.
أنشئ المفتاح
تحت New API Key (مفتاح API جديد)، انقر على Create New (إنشاء جديد). تؤكد رسالة نجاح أن المفتاح أُنشئ، ويظهر في الجدول.
انسخ المفتاح كاملًا
لا يعرض العمود API Key إلا بداية كل مفتاح ونهايته. انقر على زر النسخ بجانبه (Copy Full API Key، أي نسخ مفتاح API كاملًا) لنسخ المفتاح كاملًا، ثم الصقه في تطبيقك أو تكاملك.
تُسمّى المفاتيح تلقائيًا حسب عدد المفاتيح في مساحة العمل (API Key 1 وAPI Key 2 وهكذا)، ولا يمكن إعادة تسميتها. بعد حذف مفتاح، قد يحصل مفتاح جديد على اسم مفتاح موجود بالفعل، لذا ميّز المفاتيح بأحرفها الأولى والأخيرة وبتاريخ Created (تاريخ الإنشاء). لا تنتهي صلاحية المفاتيح: يعمل المفتاح إلى أن تحذفه.
الحد الأقصى#
يمكن أن تضم مساحة العمل حتى 10 مفاتيح API في الوقت نفسه. عند بلوغ الحد، تظهر الرسالة "You have reached the maximum limit of 10 API keys per organization." احذف مفتاحًا لم تعد تستخدمه لتتمكن من إنشاء مفتاح جديد.
جدول مفاتيح API#
| العمود | المعنى |
|---|---|
| Label (التسمية) | اسم المفتاح، مثل API Key 1. |
| API Key (مفتاح API) | الأحرف الأولى والأخيرة من المفتاح. استخدم زر النسخ للحصول على المفتاح كاملًا. |
| Created (تاريخ الإنشاء) | تاريخ إنشاء المفتاح. |
| Status (الحالة) | دائمًا Active (نشط). المفاتيح المحذوفة تُزال من الجدول. |
| Actions (الإجراءات) | يزيل Delete (حذف) المفتاح. |
احذف مفتاح API#
اعثر على المفتاح
في Settings → API Keys، اعثر على المفتاح في الجدول.
احذفه
انقر على Delete، ثم على Yes, Delete API Key (نعم، احذف مفتاح API).
لا يمكن التراجع عن حذف المفتاح. أي تطبيق لا يزال يستخدمه يتوقف عن العمل فورًا ويتلقى Auth Error: invalid api key. حدّث تطبيقاتك بمفتاح جديد أولًا.
معرّفات عملاء WhatsApp#
لكل رقم WhatsApp متصل معرّف خاص به. تحتاج معظم نقاط نهاية الرسائل إليه في الحقل whatsapp_client لاختيار الرقم الذي يرسل الرسالة.
افتح WhatsApp settings واقرأ العمود Whatsapp Client ID بجانب كل رقم. راجع اربط رقم WhatsApp الخاص بك إن لم تكن قد ربطت رقمًا بعد.
اختبر بيانات اعتمادك#
استدعِ التحقق من بيانات الاعتماد (POST /api/v1/me/) مع client_id وapi_key، ومع whatsapp_client اختياريًا. يؤكد ذلك أنها تعمل معًا دون إرسال أي شيء أو استهلاك أي رسائل. إذا كان whatsapp_client لا ينتمي إلى مساحة العمل، تكون الاستجابة Invalid WhatsApp Client ID.
إذا تسرّب مفتاح API#
أي شخص يملك مفتاح API ومعرّف عميل API الخاصين بك يمكنه إرسال رسائل من أرقام WhatsApp الخاصة بك واستهلاك رسائل مساحة العمل.
أنشئ مفتاحًا بديلًا
في Settings → API Keys، انقر على Create New وانسخ المفتاح الجديد.
حدّث تطبيقاتك
استبدل المفتاح القديم في كل تطبيق وتكامل كان يستخدمه.
احذف المفتاح المسرّب
انقر على Delete بجانب المفتاح المسرّب. يتوقف عن العمل فورًا.
تحقّق من إساءة الاستخدام
راجع الرسائل الأخيرة في Reports (التقارير) بحثًا عن أي رسالة لم ترسلها.
تعامل أيضًا مع البريد الإلكتروني "WbizTool Alert - WhatsApp Connected Successfully!" على أنه سري: يُرسل إلى منشئ مساحة العمل عند اتصال رقم لأول مرة، وقد يتضمن أحد مفاتيح API الخاصة بك.
استكشاف الأخطاء وإصلاحها#
| المشكلة | ما الذي يجب التحقق منه |
|---|---|
| يعرض تبويب API Keys الرسالة No API Keys Found (لم يُعثر على مفاتيح API)، رغم وجود مفاتيح | لست Administrator في مساحة العمل هذه، أو أن مساحة عمل أخرى محددة. |
| "You don't have permission to create API keys in this space." | لا يمكن إلا للمسؤولين (Administrators) إنشاء المفاتيح أو حذفها. يظهر زر Generate New API Key (إنشاء مفتاح API جديد) في الجدول الفارغ للجميع، لكنه لا يعمل إلا للمسؤولين. |
| "You have reached the maximum limit of 10 API keys per organization." | احذف مفتاحًا لم تعد تستخدمه. |
Auth Error: invalid api key | حُذف المفتاح أو كُتب بشكل خاطئ، أو أن client_id لا ينتمي إلى مساحة العمل نفسها التي ينتمي إليها المفتاح. إذا استمر الفشل مع مفتاح جديد ومع API Client ID المعروض في الصفحة، فتواصل مع الدعم (قد تعرض مساحات العمل الأقدم معرّف عميل API لا يعمل إلا مع المفاتيح التي أنشأها منشئ مساحة العمل). |
Auth Error - Please send correct API key and Client id | الحقل api_key مفقود من الطلب. |
Invalid client id. (أو Invalid Client Id في بعض نقاط النهاية) | الحقل client_id مفقود أو ليس رقمًا. في التحقق من بيانات الاعتماد، يؤدي غياب client_id أو api_key إلى إرجاع Auth Error فقط؛ أما Invalid Client Id هناك فتعني أنه ليس رقمًا. انسخه من بطاقة API Overview. |
| الطلبات تعمل على مساحة العمل الخطأ | أُنشئ المفتاح في مساحة عمل أخرى. بدّل مساحة العمل وأنشئ مفتاحًا فيها. |
Demo Account can not access apis | لا يمكن للحسابات التجريبية استخدام API. أنشئ حسابًا مجانيًا. |