دليل المستخدم لواجهات برمجة التطبيقات العامة APIs لـ ZenATS

نظرة عامة

تتيح لك واجهات برمجة التطبيقات العامة APIs لـ ZenATS ربط النظام بأنظمة وتطبيقات خارجية، مثل أنظمة تخطيط موارد المؤسسات (ERP)، وبناء صفحات وظائف مخصصة باستخدام بيانات التوظيف الخاصة بك في ZenATS.

ملاحظة: واجهات برمجة التطبيقات العامة متاحة فقط للعملاء المشتركين في باقة ZenATS Advanced.

للحصول على التفاصيل التقنية الكاملة، بما في ذلك نقاط النهاية المتاحة (Endpoints)، والصلاحيات، والأمثلة، يُرجى الرجوع إلى مرجع واجهة برمجة التطبيقات (API Reference) المتوفر من صفحة واجهات برمجة التطبيقات العامة.

1. الوصول إلى صفحة واجهات برمجة التطبيقات العامة

للوصول إلى واجهات برمجة التطبيقات العامة:

1. سجّل الدخول إلى ZenATS.

2. انتقل إلى إعدادات النظام (System Preferences).

3. اختر واجهات برمجة التطبيقات العامة (Public APIs) من قائمة الإعدادات.

من هذه الصفحة، يمكنك إنشاء وإدارة عملاء واجهة برمجة التطبيقات (API Clients).

2. إنشاء عميل جديد لواجهة برمجة التطبيقات

لإنشاء بيانات اعتماد API:

1. اضغط على عميل جديد (New client).

2. أدخل اسماً يساعدك على التعرف على عملية الربط، مثل:

• تكامل ERP

• موقع الوظائف الإلكتروني

3. اختر الصلاحيات المطلوبة لعملية التكامل.

4. أنشئ العميل.

بعد إنشاء العميل، يقوم ZenATS بإنشاء بيانات الاعتماد اللازمة للمصادقة عبر واجهة برمجة التطبيقات.

3. نسخ سر العميل (Client Secret) وحفظه

مباشرة بعد إنشاء عميل واجهة برمجة التطبيقات، يعرض ZenATS سر العميل (Client Secret).

هام: يظهر سر العميل مرة واحدة فقط.

يجب عليك نسخ سر العميل وحفظه في مكان آمن فور ظهوره.

بعد مغادرة الصفحة أو تحديثها، يختفي السر ولا يمكن استرجاعه مرة أخرى.

في حال فقدان سر العميل، ستحتاج إلى إلغاء بيانات الاعتماد أو استبدالها وإنشاء بيانات جديدة.

لا تشارك سر العميل علناً ولا تخزّنه في مستندات أو قنوات اتصال غير آمنة.

4. معرّف العميل (Client ID)

لكل عميل واجهة برمجة تطبيقات معرّف عميل (Client ID) فريد خاص به.

على عكس سر العميل، يبقى معرّف العميل ظاهرًا على صفحة واجهات برمجة التطبيقات العامة، ويمكن الرجوع إليه لاحقًا عند إعداد عملية الربط.

يُستخدم معرّف العميل وسر العميل للحصول على رمز الوصول (Access Token) اللازم للمصادقة عبر واجهة برمجة التطبيقات.

5. صلاحيات واجهة برمجة التطبيقات

يُمنح كل عميل واجهة برمجة تطبيقات صلاحيات محددة تتحكم بما يمكن للنظام المرتبط الوصول إليه أو تعديله.

قد تشمل الصلاحيات المتاحة إجراءات متعلقة بـ:

• المرشحين (Candidates)

• الوظائف (Jobs)

• مرشحي الوظائف / الطلبات (Job Candidates / Applications)

• مراحل التوظيف (Recruitment Stages)

• نقل المرشحين بين المراحل

• تأهيل المرشحين

• استبعاد المرشحين

امنح فقط الصلاحيات المطلوبة لعملية الربط.

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

6. إدارة عملاء واجهة برمجة التطبيقات الحاليين

تظهر عملاء واجهة برمجة التطبيقات الذين تم إنشاؤهم على صفحة واجهات برمجة التطبيقات العامة إلى جانب:

• الاسم

• معرّف العميل

• الصلاحيات

• تاريخ الإنشاء

من هذه الصفحة، يمكنك أيضًا إدارة الوصول إلى عميل موجود.

إلغاء الرموز (Revoke Tokens)

اختر إلغاء الرموز (Revoke tokens) عندما تريد إبطال رموز الوصول المرتبطة بعميل واجهة برمجة التطبيقات.

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

حذف العميل (Delete Client)

اختر حذف (Delete) عندما لا تعد بحاجة إلى عميل واجهة برمجة التطبيقات.

يؤدي حذف العميل إلى إزالة وصوله إلى واجهة برمجة التطبيقات.

7. توثيق واجهة برمجة التطبيقات

للاطلاع على تفاصيل التنفيذ، اختر مرجع واجهة برمجة التطبيقات (API Reference) من صفحة واجهات برمجة التطبيقات العامة.

يحتوي توثيق واجهة برمجة التطبيقات على نقاط النهاية المتاحة، والنطاقات (Scopes)، وتفاصيل المصادقة، وأمثلة الطلبات.

تغطي واجهات برمجة التطبيقات العامة لـ ZenATS حاليًا موارد التوظيف الأساسية مثل:

• المرشحين (Candidates)

• الوظائف (Jobs)

• مرشحي الوظائف / الطلبات (Job Candidates / Applications)

• مراحل التوظيف (Recruitment Stages)

ويمكن استخدامها لدعم عمليات الربط مع أنظمة ERP وأنظمة الأعمال الأخرى، بالإضافة إلى صفحات الوظائف المخصصة وغيرها من عمليات الربط المتعلقة بالتوظيف.

توصية أمنية

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

يجب أن يقوم الفريق التقني المسؤول عن تنفيذ عملية الربط بتخزين سر العميل بشكل آمن، ويجب ألا يُكشف أبدًا في الأكواد المصدرية العامة، أو التعليمات البرمجية من جانب المتصفح، أو المستندات المشتركة، أو أي مواقع أخرى غير آمنة.