عام · ليس للنشر بعد

مرجع API — ملخص عام

تفاصيل الطلب/الاستجابة الحساسة تبقى في وثائق المستودع الداخلية عند الحاجة. هنا ملخص آمن بعد مراجعة: مسارات مسجّلة + صلاحيات + أثر عالي المستوى. الأمثلة وهمية.

المصادقة

MethodPathAuthالغرض
POST/api/v1/auth/loginعامإصدار JWT
GET/api/v1/auth/meJWTالمستخدم الحالي
GET/api/healthعامفحص صحة

المدفوعات

MethodPathPermأثر
GET/api/v1/admin/paymentspayments.viewقراءة
POST/api/v1/admin/paymentspayments.createpending + حجز
POST.../record-collectionpayments.createpaid + ledger
POST.../cancelpayments.createcancelled
POST.../refundpayments.refundrefunded + ledger debit
POST/api/v1/payments/gateway/{code}/notifyتحقق مزوّدتحصيل إن نجح (البوابة الافتراضية معطّلة)

مثال وهمي (ليس بيانات حقيقية)

POST /api/v1/admin/payments
Authorization: Bearer <token-not-real>
{
  "family_id": 1,
  "student_id": 1,
  "amount_cents": 6500,
  "currency": "AED",
  "method": "bank",
  "reference": "DEMO-REF-001",
  "items": [{"student_fee_id": 10, "description": "Tuition", "amount_cents": 6500}]
}

التغطية

المستودع يسجّل عشرات المسارات تحت /api/v1/admin/* (أشخاص، رسوم، محافظ، مؤسسات، تقارير، رؤى…). الجرد الكامل للربط بالمصدر محفوظ داخليًا في docs/system-portal/internal/ وغير منشور مع هذه الحزمة العامة.

Routes discovered ≈ 100+ registrations including insight summaries