وحدة API من eBrigade
اربطوا eBrigade بنظام معلوماتكم
توقفوا عن إعادة إدخال موظفيكم وجداولكم ومؤهلاتكم من أداة إلى أخرى. تتيح واجهة eBrigade البرمجية (API) بياناتكم عبر تدفقات واردة وصادرة موثّقة ومؤمّنة بمفتاح: يتزامن نظام الموارد البشرية (HRIS) أو برنامج الرواتب أو البوابة الداخلية لديكم تلقائيًا، دون أي تطوير خاص من جانب eBrigade.
مضمّن دون تكلفة إضافية في كل باقات eBrigade، تجربة 30 يوماً دون بطاقة بنكية.
توضيح · بيانات نموذجية
ما هي وحدة API في eBrigade؟
مفاتيح API للاستيراد والتصدير، REST API v2 وتدفقات واردة وصادرة لربط eBrigade بنظام معلوماتكم. مضمّنة دون تكلفة إضافية في كل باقات eBrigade.
لماذا استخدام API؟
تبقى بيانات eBrigade معزولة عن أدواتكم الأخرى: نظام الموارد البشرية، وبرنامج الرواتب، والبرامج المهنية، أو البوابة الإلكترونية. كل تصدير يدوي إلى Excel، وكل إعادة إدخال لموظف أو مؤهل تستهلك الوقت وتُحدث في النهاية تباينات بين قواعد بياناتكم. ودون وصول برمجي، لا تملك فرق تقنية المعلومات لديكم وسيلة موثوقة لإبقاء eBrigade متوافقًا مع نظام المعلومات المرجعي.
ما الذي تغيّره واجهة API في eBrigade
تتيح واجهة API الوصول إلى موظفيكم، وأنشطتكم والمشاركات فيها، وكفاءاتكم وتواريخ انتهائها، ومنظماتكم، وتسجيلاتكم، وتوفركم وغياباتكم، وسجلات ساعة الحضور، ومركباتكم ومعداتكم عبر تدفقات موحّدة. يقرأ مطوروكم هذه البيانات (GET) ويرسلون بيانات من أدواتكم الخارجية (POST) بمفتاح بسيط. تُعيد REST API v2 بيانات JSON متسقة ومقسّمة إلى صفحات وموثّقة ذاتيًا؛ وكل استدعاء يُحتسب ويُقيَّد ويُعرض في لوحة استخدام، ويمكن حصر الوصول في عناوين IP الخاصة بكم فقط.
ما يمكنكم فعله مع واجهة API
مفتاحان منفصلان — أحدهما للتدفقات الواردة (الاستيراد) والآخر للتدفقات الصادرة (التصدير) — يُنشآن ويُجدَّدان بنقرة واحدة من منطقة الإدارة. وتجديد مفتاح مخترق يُبطل القديم فورًا دون التأثير على التدفق الآخر.
أرسلوا موظفيكم وأنشطتكم/دوراتكم التدريبية ومهاراتكم إلى eBrigade من نظام الموارد البشرية أو الدليل المرجعي لديكم. ويعالج الاستيراد التحديث كما الإنشاء (create_if_not_exists) والمطابقة بالمعرّف الداخلي أو المعرّف الخارجي (use_external_id)، بما في ذلك UUID.
اعرضوا للقراءة فقط أعضاءكم وأنشطتكم والمشاركة خلال فترة، ومرجع المهارات وتواريخ انتهاء صلاحية كل شخص، وجهاتكم، والتسجيلات في الأنشطة المدفوعة، والتوفر والغيابات وسجلات تسجيل الحضور، إضافة إلى مركباتكم ومعداتكم. مثالي لتغذية الرواتب أو التقارير أو لوحة ذكاء الأعمال.
المصادقة عبر ترويسة Authorization: Bearer، واستجابات JSON موحّدة {success, data, meta}، وتقسيم الصفحات (page، per_page)، والتحديث الجزئي للسجل عبر PATCH، وترويسات CORS ورموز HTTP واضحة. نقاط النهاية والمعاملات وأمثلة cURL موثقة مباشرة في الواجهة، دون أي توثيق خارجي.
تخضع المنصة لحدّ أقصى (افتراضيًا 10,000 طلب يوميًا و60 طلبًا في الدقيقة لكل مفتاح) مع ترويسات X-RateLimit واستجابة HTTP 429 عند تجاوز الحد. وتعرض لوحة متابعة طلبات اليوم والحصة المتبقية وآخر نقطة نهاية مستدعاة ووقت آخر استدعاء.
فعّلوا تصفية عناوين IP لقبول الطلبات من الخوادم المصرّح بها فقط: يُرفض أي طلب من عنوان IP غير موجود في قائمة السماح (HTTP 403)، حتى مع مفتاح صالح.
وأيضًا: بيانات مُصدَّرة جديدة · مكتبة الموصِّلات
واجهة API في التطبيق
لقطات شاشة من التطبيق الحقيقي، وليست نماذج تصميم.



خطوة بخطوة
- أنشئوا مفاتيح API الخاصة بكم
من منطقة الإدارة، فعّلوا واجهة API للتصدير وأنشئوا مفتاح التصدير ورمز الاستيراد بنقرة واحدة. يمكنكم إعادة إنشائهما في أي وقت لإلغاء الوصول.
- أمّنوا الوصول واختبروه
عند الحاجة، فعّلوا التقييد بقائمة عناوين IP مسموح بها، ثم اختبروا استدعاءاتكم بأمثلة cURL المتوفرة في الواجهة لكل نقطة نهاية (الأشخاص، الأحداث، المهارات، الأقسام، التسجيلات).
- اربطوا أدواتكم وراقبوا
يستعلم نظام معلوماتكم عن البيانات (GET) أو يرسلها (POST) عبر التدفقات الموثقة. تعرض لوحة الاستخدام طلبات اليوم والحصة المتبقية وآخر استدعاء لتراقبوا عمليات التكامل لديكم.
الأسئلة الشائعة
هل يمكن لأداة خارجية الكتابة في سجل الأحداث؟
نعم. تقبل API v2 رسالة في سجل أحداث النشاط (POST /api/v2/events/{id}/logbook): النص والعنوان والوقت والأهمية واسم الأداة الذي يظهر كمُرسِل. ويجعل معرّف مرجعي الاستدعاء متساوي الأثر (idempotent): فالتنبيه نفسه المرسل مرتين ينشئ سطرًا واحدًا. ويُقرأ السجل من العنوان نفسه مع مرشح «منذ». ويتطلب الإدخال تفعيل واجهة API للاستيراد.
ما أنواع البيانات التي يمكن الوصول إليها عبر API؟
القراءة (التدفقات الصادرة): الموظفون، والأنشطة، والمشاركة خلال فترة، والقائمة المرجعية للمهارات وتواريخ انتهاء المهارات المكتسبة، والمؤسسات، والتسجيلات في الأنشطة المدفوعة، والتوفّر، والغيابات، وسجلات ساعة الحضور، وأسطول المركبات والمعدات. الكتابة (التدفقات الواردة): استيراد الموظفين وتحديثهم (السجل كاملًا أو الحقول المرسلة فقط، عبر PATCH)، واستيراد الأنشطة/الدورات التدريبية وإسناد المهارات.
كم مفتاح API يمكن إنشاؤه؟
تعتمد واجهة API على مفتاحين: مفتاح للتصدير (التدفقات الصادرة) ورمز للاستيراد (التدفقات الواردة). ويُنشأ كلٌّ منهما ويُعاد إنشاؤه بشكل مستقل من مساحة الإدارة. وفي API v2، يمكن لمفتاح واحد أن يؤدي الغرضين عبر الترويسة Authorization: Bearer.
هل هناك REST API حديثة، أم يجب استخدام الصيغة القديمة؟
الإصدار 2: لم يعد الإصدار 1 القديم متاحًا، ولا تُحفظ نقاط نهايته إلا للتكاملات القائمة. يضيف API v2 مصادقة Bearer، وJSON موحّدًا {success, data, meta}، والترقيم، وترويسات CORS، ورموز HTTP صريحة، مع بقائه متوافقًا مع نقاط نهاية v1 الحالية.
هل توجد حدود لمعدل الطلبات؟
نعم. افتراضيًا، يقتصر النظام على 10,000 طلب يوميًا، وكل مفتاح على 60 طلبًا في الدقيقة. وتتضمن الاستجابات ترويسات X-RateLimit وتُعيد رمز HTTP 429 عند تجاوز الحد. وتتيح لوحة استخدام متابعة استهلاككم في الوقت الفعلي.
كيف يُؤمَّن الوصول إلى API؟
إلى جانب المفتاح، يمكنكم تفعيل التقييد بقائمة مسموح بها من عناوين IP: يُرفض أي طلب من عنوان غير مدرج (HTTP 403). ويُفضَّل إجراء المصادقة عبر ترويسة Bearer بدلاً من وضعها نصاً صريحاً في الرابط.