REST API v1

توثيق واجهة نائب

كل شاشة في «نائب» لها نظير في REST API واحد. عربي RTL، عملة AED، تاريخ ديمو ثابت 2026-09-13 — وكل نداء يقرأ الحالة الحقيقية ويظهر أثره فوراً.

الإصدار 1.0.0/api/v1AED فقطOpenAPI 3.1

تحميل openapi.json

غلاف النجاح

{ "data": { ... }, "meta": { "total": 4, "page": 1 } }

القوائم ترجع data + meta، والعنصر/العملية ترجع data فقط.

غلاف الخطأ

{ "error": { "code": "VALIDATION", "message": "رسالة عربية" } }

VALIDATIONNOT_FOUNDCONFLICTUNAUTHORIZEDRATE_LIMITEDINTERNAL

المجموعات

21مجموعة CRUD كاملة

Aliases إلزامية: deals → opportunities · payments → receipts. كل تعديل يظهر فوراً في /company/summary.

119 endpoint

النظام والتوثيق

فهرس الـ API

الحالة

OpenAPI 3.1

الشركة والمؤشرات والقرارات

مؤشرات الشركة

ملخص الشركة — نقد · إيراد · محصلات · فرص · مهام

نفس `companySummary` من `src/lib/naeb.ts` — يُقرأ مباشرة من الحالة كل نداء.

Curl

curl -s -X GET '/api/v1/company/summary' \
  -H 'Accept: application/json'

ينفّذ الطلب فعلاً على الـ API الحقيقي ويعدّل بيانات الديمو.

صندوق القرارات

السياسات

السيناريو والاعتماد

سيناريو SC1

بيانات الشركة (CRUD)

108

الإيصالات (payments)

الفرص (deals)

إيصالات الفواتير

الإدارات

الموظفون

الخدمات

العملاء

الحملات التسويقية

العقود

المشاريع

الإيرادات المعترف بها

الموردون

المصروفات

المهام

التذاكر

طلبات الشراء

الأصول

الأهداف

الإجازات

سجل الأنشطة والتواصل

قاعدة المعرفة

عمليات الديمو

إعادة ضبط الديمو

المستند الرسمي الكامل: /api/v1/openapi.json

كل البيانات تجريبية — استخدم «إعادة ضبط الديمو» في أي وقت