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

واجهة مُجيب البرمجية (API) لقراءة عملاء واتساب وحجوزاتهم

واجهة مُجيب البرمجية (REST API) تتيح لنظامك أن يقرأ عملاء نشاطك الذين راسلوك على واتساب وماسنجر وإنستغرام، وأن يقرأ حجوزاتهم، بمفتاح API تنشئه من لوحة التحكم. وهي للقراءة فقط: لا ترسل رسائل واتساب ولا تغيّر أي بيانات، وكل ردودها بصيغة JSON.

تفيدك الواجهة عندما تريد أن تصل بيانات مُجيب إلى نظام آخر تملكه: لوحة تقارير، أو نظام مبيعات، أو جدول يتحدّث وحده. يكتب المطوّر برنامجًا يطلب البيانات متى احتاجها، ويجيبه مُجيب ببيانات نشاطك وحده.

ما الذي تقرأه واجهة مُجيب البرمجية؟

رابط القسم «ما الذي تقرأه واجهة مُجيب البرمجية؟»

تقرأ الواجهة ثلاثة أشياء: نشاطك والمفتاح نفسه، وعملاءك، وحجوزاتك. كل واحد منها طلب GET مستقل:

الطلبما يعيدهالصلاحية المطلوبةالمرجع
GET /api/v1/meاسم النشاط واسم المفتاح وصلاحياتهلا شيءاختبار المفتاح
GET /api/v1/contactsقائمة العملاء، الأحدث أولًاcontacts.readقائمة العملاء
GET /api/v1/contacts/{id}عميل واحدcontacts.readعميل واحد
GET /api/v1/bookingsالحجوزات بحسب أيام الفرعbookings.readقائمة الحجوزات
GET /api/v1/bookings/{id}حجز واحدbookings.readحجز واحد

يرى المفتاح بيانات النشاط الذي أنشأه فقط. لا يوجد في الطلب ما يختار نشاطًا آخر، فلا يصل مفتاح نشاطٍ إلى بيانات نشاطٍ غيره.

هل هذه واجهة واتساب API لإرسال الرسائل؟

رابط القسم «هل هذه واجهة واتساب API لإرسال الرسائل؟»

لا. واجهة مُجيب البرمجية لا ترسل رسائل واتساب ولا أي رسائل أخرى، ولا تنشئ حجوزات ولا تعدّلها. الرد على العملاء يتولاه الوكيل وفريقك من لوحة التحكم.

  • إذا أردت أن يصلك كل عميل جديد أو حجز جديد لحظة حدوثه، فاستخدم Webhooks بدل أن تسأل الواجهة كل دقيقة.
  • إذا كنت تبحث عن الفرق بين تطبيق واتساب للأعمال وواجهة واتساب الرسمية، فاقرأ واتساب للأعمال وWhatsApp API.
  • ربط رقم واتساب بمُجيب يتم من لوحة التحكم، وخطواته في ربط واتساب.

كيف أبدأ باستخدام الواجهة؟

رابط القسم «كيف أبدأ باستخدام الواجهة؟»

تحتاج إلى مفتاح API وإلى برنامج يرسل طلبات HTTPS. هذا أقصر طريق:

  1. أنشئ مفتاحًا من «التكاملات» بالضغط على بطاقة «مفاتيح API»، واختر ما يقرأه. الخطوات كاملة في مفتاح API والمصادقة.
  2. احفظ المفتاح في متغير بيئة على خادمك، مثل MUJIB_API_KEY.
  3. جرّب المفتاح بطلب GET /api/v1/me. إذا عاد اسم نشاطك فالمفتاح يعمل:
نافذة طرفيّة
curl https://api.mujib.ai/api/v1/me \
-H "Authorization: Bearer $MUJIB_API_KEY"
{
"workspace": { "name": "مركز النخبة" },
"key": { "name": "تقارير المبيعات", "scopes": ["contacts.read", "bookings.read"] }
}
  1. اقرأ العملاء أو الحجوزات صفحةً بعد صفحة، كما يشرح التقسيم إلى صفحات.
قسم المطوّرين مفتوحًا بمفاتيح API والـ Webhooks وطريقة الاستعمال
بعد فتح «للمطوّرين» يظهر جزء «مفاتيح API» مع زر «مفتاح جديد»، وجزء «Webhooks» مع زر «Webhook جديد»، وفي الأسفل «كيف تستعملها».

أمثلة الصفحات مكتوبة بثلاث صيغ: curl، وJavaScript تعمل في Node.js بالدالة fetch المضمّنة (احفظها في ملف .mjs)، وPython بمكتبة requests.

ما عنوان الواجهة وما صيغة الطلبات والردود؟

رابط القسم «ما عنوان الواجهة وما صيغة الطلبات والردود؟»

عنوان الواجهة https://api.mujib.ai/api/v1، وكل طلباتها GET عبر HTTPS بمفتاح في الترويسة. وهذه قواعدها المشتركة:

  • المصادقة: الترويسة Authorization: Bearer mjb_live_… في كل طلب. جلسة لوحة التحكم لا تفتح الواجهة، والمفتاح لا يوضع في الرابط أبدًا.
  • الردود: JSON. القائمة تأتي في data ومعها nextCursor للصفحة التالية، والعنصر الواحد يأتي في data.
  • الأوقات: لحظات بتوقيت UTC بصيغة ISO، مثل 2026-11-04T18:22:09.117Z. والحجز يحمل أيضًا وقته المحلي في الفرع ومنطقته الزمنية.
  • الأخطاء: كلها بالشكل { "error": { "code": "…", "message": "…" } }، والرمز code ثابت تبني عليه برنامجك. القائمة في الأخطاء وحدود الطلبات.
  • الحد: 60 طلبًا في الدقيقة لكل مفتاح.
  • التخزين المؤقت: لا تُخزَّن الردود (Cache-Control: no-store)، فكل طلب يقرأ البيانات كما هي الآن.

والوصف الكامل لكل طلب وحقل موجود في ملف OpenAPI، لتولّد منه عميلًا بلغتك أو تستورده في أداة اختبار الطلبات.

متى أستخدم الواجهة، ومتى Webhooks أو المساعدات الذكية؟

رابط القسم «متى أستخدم الواجهة، ومتى Webhooks أو المساعدات الذكية؟»

استخدم الواجهة عندما يحتاج برنامجك أن يسأل عن البيانات بنفسه، واستخدم Webhooks عندما تريد أن يخبرك مُجيب بالحدث فور وقوعه.

ما تريدهالأنسبالسبب
تقرير يومي، أو مزامنة دورية للعملاء والحجوزاتالواجهة البرمجيةتقرأ ما تشاء متى تشاء، صفحةً بعد صفحة
إشعار نظامك بعميل جديد أو حجز جديد أو إلغاء لحظة حدوثهWebhooksيرسل مُجيب الحدث إلى رابطك، فلا حاجة إلى السؤال المتكرر
أن تسأل عن نشاطك من ChatGPT أو Claudeخادم MCPيربط المساعد بحسابك دون كتابة كود
ربط أدوات الأتمتة دون برمجةأدوات الأتمتةتبني على Webhooks بخطوات جاهزة

الواجهة تُخرج الحقول الموثّقة فقط، ولا تتيح الكتابة.

  • لا محادثات: لا يخرج نص الرسائل ولا الوسائط.
  • لا بيانات داخلية: ملاحظات فريقك، والحقول المخصّصة، وتقييم العميل المحتمل، وما يتذكّره الوكيل عن العميل، كلها تبقى في مُجيب.
  • لا استدعاء من المتصفح: الواجهة لا تسمح للمتصفح بطلبها من صفحات المواقع الأخرى، فاستدعِها من خادمك.
  • لا إنشاء ولا تعديل ولا حذف: كل الطلبات GET، وأي طريقة أخرى تُرفض.

الأسئلة الشائعة

هل تُرسل واجهة مُجيب البرمجية رسائل واتساب؟

لا. الواجهة للقراءة فقط، تقرأ العملاء والحجوزات ولا ترسل رسائل ولا تغيّر أي بيانات. الرد على العملاء يتولاه الوكيل وفريقك من لوحة التحكم.

من يستطيع إنشاء مفتاح API؟

«المالك» و«مدير» فقط، من صفحة «التكاملات». حسابات الموظفين لا ترى هذه الصفحة.

هل أستطيع استدعاء الواجهة من متصفح الزائر في موقعي؟

لا. استدعِها من خادمك. الواجهة لا تسمح للمتصفح بطلبها من صفحات المواقع الأخرى، والمفتاح يقرأ أسماء عملائك وأرقامهم فلا يجوز أن يظهر في كود الصفحة.

كم طلبًا أستطيع أن أرسل؟

60 طلبًا في الدقيقة لكل مفتاح. التفاصيل في صفحة الأخطاء وحدود الطلبات.

هل تقرأ الواجهة نص المحادثات؟

لا. تقرأ بيانات العميل الأساسية وحجوزاته فقط، ولا تُخرج الرسائل ولا ملاحظات فريقك ولا الحقول المخصّصة.