مفاتيح API

مفاتيح API تسمح للأنظمة الأخرى باستخدام واجهة REST الخاصة بالنظام (‎/api/v1). واستخدامها الأساسي هو نظام الدوام: فهو يرسل موظفيه إلى هنا، فتبقى قائمة الموظفين محدَّثة دون إدخال أحد يدويًا. يعمل المفتاح باسم مستخدمه: فتنطبق صلاحيات ذلك المستخدم، وتضيّقها صلاحيات المفتاح.

من القائمة الجانبية، افتح الإعدادات › مفاتيح API.

محتويات الشاشة

• إنشاء مفتاح
• ربط نظام الدوام (Timesheet): ما تلصقه في نظام الدوام (انظر أدناه).
• ابحث باسم المفتاح وعاملا التصفية المستخدم والحالة (نشط أو منتهي).
• قائمة المفاتيح. وبدون مفاتيح تعرض لا توجد مفاتيح API بعد.

الأعمدة

• الاسم
• المستخدم: المستخدم الذي يعمل المفتاح باسمه.
• الصلاحيات: ما يُسمح للمفتاح بفعله.
• الحالة: نشط أو منتهي أو المستخدم غير نشط (لا يعمل مفتاح مستخدم موقوف).
• آخر استخدام: أو لم يُستخدم.
• ينتهي في: التاريخ، أو بلا انتهاء مع التنبيه يعمل حتى يُلغى. استبدله بمفتاح له تاريخ انتهاء.
• تاريخ الإنشاء
• إلغاء: أيقونة سلة المهملات.

الحقول

• المستخدم (إلزامي): مستخدم نشط. ويُفضَّل مستخدم خدمة مخصص (مثل “نظام الدوام”) أدواره هي بالضبط ما يحق للنظام الآخر فعله: الموظفون › عرض للقراءة، والموظفون › مزامنة من نظام الدوام لإرسال الموظفين.
• الاسم (إلزامي): حتى 100 حرف، مثل نظام الدوام.
• الصلاحيات (إلزامية، واحدة على الأقل):
  • read: قراءة الموظفين (وشريحتهم الحالية).
  • write:employees: يرسل نظام الدوام الموظفين: إضافتهم وتعديلهم وتغيير حالتهم.
• ينتهي في: بعد سنة من اليوم افتراضيًا، وسنتان على الأكثر. ويتوقف المفتاح عن العمل بنهاية هذا اليوم. ولا يستطيع تحديد لا ينتهي أبدًا (للمشرف العام فقط) إلا المدير العام.

كيفية إنشاء مفتاح

1. اضغط إنشاء مفتاح.
2. اختر المستخدم، واكتب الاسم، وحدّد الصلاحيات، وراجع ينتهي في.
3. اضغط إنشاء. وإن لم تكتب كلمة مرورك خلال آخر 15 دقيقة فأكّدها أولًا.
4. يظهر المفتاح مرة واحدة: تم إنشاء المفتاح “…”. اضغط نسخ المفتاح واحفظه في مكان آمن وسلّمه للنظام الآخر، ثم اضغط نسخته.

ويتلقى مستخدم المفتاح رسالة تفيد بأن مفتاح API جديدًا يعمل باسمه، مع صلاحياته وتاريخ انتهائه.

تنبيه

لا يظهر المفتاح إلا هذه المرة. وإذا فُقد فألغِه وأنشئ مفتاحًا جديدًا.

كيفية ربط نظام الدوام

يرسل نظام الدوام موظفيه إلى هنا: فيصل الموظفون الجدد والتعديلات وحالات الإيقاف تلقائيًا.

1. من الإعدادات › المستخدمون أنشئ مستخدم خدمة، مثل “نظام الدوام”، بدور فيه الموظفون › عرض والموظفون › مزامنة من نظام الدوام.
2. من هذه الشاشة أنشئ مفتاحًا لهذا المستخدم بالصلاحيتين read وwrite:employees وبتاريخ انتهاء، ثم انسخه.
3. في نظام الدوام افتح الإعدادات › الأنظمة المرتبطة، وأضف هذا النظام والصق:
   • رابط هذا النظام: العنوان الظاهر في بطاقة ربط نظام الدوام (Timesheet) (استخدم زر النسخ)، مثل https://sims.example.com؛
   • المفتاح: المفتاح الذي نسخته.

وقبل تاريخ الانتهاء أنشئ مفتاحًا جديدًا والصقه في نظام الدوام، ثم ألغِ المفتاح القديم.

كيفية إلغاء مفتاح

1. اضغط أيقونة سلة المهملات في صف المفتاح.
2. اقرأ إلغاء المفتاح وأكّد بالضغط على إلغاء. يتوقف المفتاح عن العمل فورًا، وتتلقى الأنظمة التي تستخدمه خطأ 401.

ملاحظة

لا يمكنك إدارة مفاتيح مستخدم لديه وصول أكبر منك (لا يمكنك إدارة مفاتيح هذا المستخدم (لديه وصول أكبر منك).).

الصلاحية المطلوبة

مفاتيح API › إدارة. ويتطلب إنشاء المفتاح وإلغاؤه تأكيدًا حديثًا لكلمة المرور.