واجهة برمجة التطبيقات (API)

منصة تدبير للمؤشرات المالية

الخدمة تعمل الإصدار v1 بيئة التطوير

تحلّل المنصة القوائم المالية للمنشآت، وتحسب منها 14 مؤشرًا ماليًا في الربحية والنشاط والمديونية والتدفق النقدي، ثم تقارنها بالمعايير القطاعية المعتمدة ومتوسط المنشآت المشابهة، وتقدّم تقارير مفصّلة بخلاصة تنفيذية لكل منشأة أو محفظة.

مجموعات الواجهة

المصادقة

تسجيل الدخول برمز التحقق، وإدارة جلسة المستخدم.

/api/v1/auth

البيانات المرجعية

الأنشطة والمدن وأحجام المنشآت، ونموذج إدخال القوائم المالية.

/api/v1/lookups

المنشآت

تسجيل المنشأة وبياناتها الأساسية ونشاطها.

/api/v1/companies

القوائم المالية

إدخال القوائم لكل سنة مالية، وحساب المؤشرات منها.

/api/v1/accounts

التقارير

تقرير المنشأة، ومقارنة السوق، والمقارنة عبر السنوات، وتقرير المحفظة.

/api/v1/reports

المحافظ

تجميع عدة منشآت في محفظة واحدة وتحليلها مجتمعة.

/api/v1/portfolios

الاشتراكات

الباقات المتاحة واشتراك المستخدم وصلاحياته.

/api/v1/subscriptions

لوحة الإدارة

المعايير القطاعية، ونصوص التحليل، والمستخدمين والباقات.

/api/v1/admin

بنية وتقنيات الخادم (Backend Stack)

Node.js

بيئة التشغيل، بوحدات ES Modules.

TypeScript v5

لغة المشروع بالكامل، بأنواع صارمة.

Express v4

خادم HTTP والتوجيه والوسائط.

Prisma v6

طبقة الوصول إلى قاعدة البيانات (ORM).

MySQL

قاعدة البيانات العلائقية.

Nodemailer v6

إرسال رموز التحقق بالبريد الإلكتروني.

Multer v2

رفع ملفات القوائم المالية.

Vitest v3

الاختبارات الآلية للمؤشرات والمسارات.

مسار الطلب عبر طبقات الخادم

1

المسارات

استقبال الطلب والتحقق من مدخلاته.

routes
2

الوسائط

المصادقة، وصلاحيات الباقة، ومعالجة الأخطاء.

middleware
3

الخدمات

منطق التطبيق: المنشآت والاشتراكات والملفات.

services
4

النطاق المالي

حساب المؤشرات، والمقارنة بالمعايير، وصياغة التحليل.

domain
5

البيانات

التخزين والاستعلامات.

Prisma · MySQL

معلومات الاستخدام

العنوان الأساسي
/api/v1
صيغة البيانات
JSON في الطلبات والاستجابات
المصادقة
رمز في الترويسة Authorization: Bearer <token>
اللغة
العربية افتراضيًا، وتُحدَّد بالترويسة Accept-Language
فحص الحالة
/up