API — المنصة (الصحة، الإعدادات، لوحة المعلومات، التدقيق)
الغرض
نقاط نهاية المنصة الشاملة: فحص الصحة، إعدادات وحدة العمل، لوحة معلومات هبوط المدير، والوصول للقراءة إلى سجل أحداث التدقيق.
نقاط النهاية
Health — القاعدة /api/Health
| Method | Path | Purpose | Gate |
|---|---|---|---|
| GET | /api/Health |
الفاعلية + قاعدة البيانات/الإصدار | none (open) |
نقطة نهاية الصحة هي التي يستدعيها الهيكل الأساسي للجوال (انظر المهام الخلفية / الورقة 20).
Settings — القاعدة /api/settings
| Method | Path | Purpose | Gate |
|---|---|---|---|
| GET | /api/settings |
قراءة إعدادات BU | [Authorize] |
| PATCH | /api/settings |
تحديث إعدادات BU | admin.config |
Dashboard — القاعدة /api/dashboard
| Method | Path | Purpose | Gate |
|---|---|---|---|
| GET | /api/dashboard/summary |
بطاقات هبوط المدير | dashboard.view |
Audit events — القاعدة /api/audit/events
| Method | Path | Purpose | Gate |
|---|---|---|---|
| GET | /api/audit/events |
استعلام سجل التدقيق | admin.audit (resolved in-handler) |
dashboard.view تحملها جميع الأدوار باستثناء EMPLOYEE؛ وadmin.audit يحملها SYS_ADMIN + HR_ADMIN (انظر مصفوفة RBAC).
الأشكال والأخطاء
يُرجع /api/dashboard/summary أعداد البطاقات (ملخص هبوط، بطاقات JSON — لا رسوم بيانية، الورقة 17). يقرأ /api/audit/events جدول audit_events الذي لا يُلحَق به إلا إضافةً؛ ويُفوّض المعالج السياسة المطلوبة صراحةً قبل الإرجاع. ProblemDetails القياسي عند الإخفاق.
المزالق
- التدقيق هنا للقراءة فقط وانتقائي عند المصدر. لا يحتوي السجل إلا الأحداث التي سجّلتها الخدمات صراحةً — وهو ليس ظلًّا تلقائيًا لكل كتابة (انظر التدقيق والحذف الناعم).
- لوحة المعلومات بطاقات، لا تحليلات — ملخصات الاستغلال/المساواة بصيغة JSON فقط في مواضع أخرى؛ لا توجد مكتبة رسوم بيانية (الورقة 17).
admin.configيقيّد كتابة الإعدادات فقط — القراءات مفتوحة لأي مستخدم مُصادَق عليه.
ذات صلة
- التدقيق والحذف الناعم · مصفوفة RBAC
- Swagger:
/swagger· أوراق الحقائق 01 (الأساس)، 17 (التقارير ولوحات المعلومات).