التوثيق

توثيق API والمنصة

كل خدمة خلفية تقدّم واجهة Swagger تفاعلية مباشرة على /docs، وتُولَّد مواصفة OpenAPI موحّدة في docs/api/openapi.yaml بمستودع المنصة.

كل الطلبات تمر عبر بوابة API. المصادقة عبارة عن Bearer JWT (Authorization: Bearer <token>) على كل مسار عدا التسجيل، تسجيل الدخول، استعادة كلمة المرور، وكتالوج الفوترة العام.

الوحدات

Auth
/api/v1/auth, /api/v1/users

التسجيل، تسجيل الدخول، المصادقة الثنائية، إدارة الملف الشخصي وكلمة المرور ذاتياً.

Billing
/api/v1/billing

الباقات، الدفع، الاشتراكات، الفواتير، ويب هوك.

Pentest
/api/v1/engagements, /api/v1/scans

دورة حياة الفحص، إرسال الفحوصات، النتائج.

Vuln-Scan
/api/v1/assets, /api/v1/findings

سجل الأصول، الفحص المجدول، تقارير الامتثال.

SOC
/api/v1/soc

استيعاب الأحداث، الربط، التنبيه المعزول لكل مستأجر.

Threat Intel
/api/v1/threats

إدارة مؤشرات الاختراق، تنميط بصمة التهديد.

DFIR
/api/v1/dfir

إدارة الحالات، الأدلة، الخط الزمني.

EASM
/api/v1/easm

التحقق من النطاق، الاكتشاف، تتبع الانكشاف.

BAS
/api/v1/bas

سيناريوهات محاكاة الهجوم ونتائجها.

Mobile
/api/v1/mobile

فحوصات قائمة تحقق مُعلنة ذاتياً، جلسات المختبر الديناميكي.

AI / Chat
/api/v1/chat, /api/v1/copilot

المساعد الذكي وكوبايلوت محلل SOC.

التوثيق | VulneraX