الهدف الأساسي من توفير واجهة برمجة التطبيقات العامة (Open APIs):
هي طريقة للوساطة البرمجية بين الأنظمة والتطبيقات، هدفها تسهيل استفادتك وحصولك على وظيفة يقوم بها نظام أو تطبيق دون أن تبرمج هذه الميزة من الصفر. وبالتالي فالغرض من واجهات برمجة التطبيقات API هو تبادل البيانات والميزات المختلفة بين الأنظمة سواء لأتمتة العمليات اليدوية أو لإنشاء وظائف جديدة لم تكن موجودة في نظامك أو تطبيقك مما يسرع في عملية الربط والتكامل.
من خلال هذه الطريقة فأنت تمنح الإذن أو التفويض لطرف ثالث (تطبيق أو منصة) بالوصول لبيانات جسر أو إرسال بيانات إلى جسر بحسب واجهة برمجة التطبيقات التي تم تحديدها و تم السماح لمطور النظام بالاطلاع عليها
هي أداة تقنية جديدة تتيح الربط المباشر والآلي بين نظام "جسر" والأنظمة المحاسبية الخارجية (مثل برامج ERP).
ملحوظة: يمكن للمستخدم تحميل القيود المحاسبية وتصدير القيود المحاسبية من خلال ال API
كما يمكن تحميل القيود المحاسبية بصيغة ملف اكسل للاطلاع عليها قبل تصديرها.
أنواع واجهة برمجة التطبيقات المتاحة حاليا على جسر:
| الفئة | النوع | الغرض |
| المصادقة (التأكد من صحة المعلومات) | الحصول على رمز الوصول لـ API | تُستخدم واجهة برمجة التطبيقات API لإنشاء رمز وصول للوصول إلى واجهة برمجة التطبيقات المفتوحة Open API على النظام بناءً على الأذونات المخصصة ل API key. |
| الحضور | الحصول على ملخص الحضور | يتمكن المستخدم من استرداد ملخص الحضور للموظفين ضمن نطاق زمني محدد، يكون النطاق الزمني الافتراضي حالياً هو الشهر . يتمتع الطلب بإمكانية التصفية حسب الرقم التعريفي للموظف ID والحالة ومن التاريخ وحتى التاريخ والصفحة و عدد النتائج في الصفحة (rpp). |
| سجل الحضور | عرض سجلات تسجيل الحضور والانصراف | توفر نقطة النهاية هذه لواجهة برمجة التطبيقات حالة عمليات تسجيل الحضور أو الانصراف، سواء كانت ناجحة أم فاشلة. |
| إنشاء مجموعة من عمليات تسجيل الحضور والانصراف. | توفر نقطة نهاية لواجهة برمجة التطبيقات هذه إنشاء مجموعة من عمليات تسجيل الحضور والانصراف باستخدام نظام للدخول الإلكتروني. | |
| الموظفين | الحصول على معلومات الموظف الأساسية | تستخدم هذه الواجهة للحصول على معومات الموظف الأساسية من جسر (و ذلك على مستوى الموظف نفسه) |
| الحصول على معلومات جميع الموظفين | تستخدم هذه الواجهة للحصول على جميع بيانات الموظفين بحالة (نشط) على جسر | |
| إرسال بيانات الموظفين إلى جسر | تستخدم هذه الواجهة للسماح بإضافة بيانات الموظفين الجدد على جسر من خلال أنظمة تتبع التوظيف بهدف التخلص من إدخال البيانات بشكل يدوي | |
| إجازة الموظفين | عرض ملخص رصيد الإجازات السنوية | تقوم نقطة نهاية API هذه باسترداد ملخص الإجازة السنوية للموظفين. |
| المالية | قائمة جميع أنواع المعاملات المحاسبية | تقوم نقطة نهاية API هذه باسترداد جميع أنواع المعاملات المحاسبية GL داخل المؤسسة. |
| عرض معاملات الرواتب |
يتم استخدام واجهة برمجة التطبيقات هذه لعرض جميع معاملات الرواتب. وهذه الأنواع المدعومة:- دورة الرواتب (عادي)، مخالصات نهائية، مخالصات الإجازات، المعاملات خارج مسير الرواتب. |
للبدء في عملية الربط، لا بد من إنشاء مفتاح واجهة برمجة التطبيقات والذي تم توضيح الهدف من استخدامه أعلاه
للحصول على بيانات الربط الكاملة بشكل مفصل والاستفادة من خاصية واجهة برمجة التطبيقات العامة (Open APIs) للربط مع جسر، يرجى زيارة الرابط أدناه:
دليل واجهة برمجة التطبيقات العامة
خطوات إنشاء مفتاح واجهة برمجة التطبيقات:
1. يتاح للمستخدم بصلاحية "مشرف" على نظام جسر إمكانية إنشاء مفاتيح API و مفاتيح سر API كذلك
2. اذهب إلى قسم الإعدادات و اضغط على مفاتيح API
3. اضغط على مفتاح API جديد كما هو موضح في الصورة التالية
4. ابدأ بتعبئة البيانات في الحقول الموضحة في الصور التالية مع ضرورة أخذ الملاحظات المرفقة في كل صورة بعين الاعتبار
ملاحظة:
أي API لم يتم تحديده عند إنشاء مفتاح الربط لن يتمكن مطور النظام من الوصول إلى البيانات المتعلقة به
5. اضغط على إنشاء كما هو موضح في الصورة أعلاه للحصول على مفتاح API و مفتاح سر API
6. يمكن نسخ هذه البيانات من خلال الضغط على زر نسخ كما هو موضح في الصورة التالية ومن ثم مشاركتها مع المطور /المبرمج المسؤول عن عملية الربط
ملاحظة:
يمكن نسخ مفتاح سر API مرة واحدة فقط
7. سيظهر في الصفحة الرئيسية لمفاتيح API جميع المفاتيح التي تم إنشاءها مما يمكن المستخدم من البحث عن أي منها، و كذلك التعديل أو إضافة أو حذف أي منها
ملاحظة:
يرجى الأخذ بعين الاعتبار أن الحقول التي يمكن التعديل عليها هي المذكورة أدناه فقط:
- اسم مفتاح API
- قائمة مفاتيح API التي يمكن فتحها لمطور النظام
- قائمة جداول البيانات
مقالات ذات صلة:
كيفية تفعيل وإستخدام الـ ويب هوك Webhooks
دليل المستخدم لتفعيل التكامل مع فودكس
تعليقات
لا توجد تعليقات
الرجاء تسجيل الدخول لترك تعليق.