مرجع API

النقاط العاملة فعلًا في هذا البناء — لا غير.

الاستيثاق

توكن حامل قصير العمر في ترويسة Authorization. كل طلب يُعاد تقييمه: الهوية، المستأجر، النطاق، الإذن، الرؤية، وحالة النسخة.

التوكن الموثّق يحمل: المعرّف، نوع الهوية، مستأجرًا واحدًا، والنطاقات — غياب أيٍّ منها رفض كامل.

GET /v1/me — هوية المستدعي وأدواره وأذوناته في المستأجر الحالي.

النطاقات

النطاق سقف في التوكن. يحصل عميل الخدمة على تقاطع نطاقات التوكن مع النطاقات الممنوحة لحسابه.

النطاقات المتاحة لعملاء الخدمة
النطاقالمعنى
curriculum:readقراءة المناهج والأطر والصفوف.
outcome:readقراءة النتاجات والمهارات والمعايير.
association:readقراءة علاقات الجراف.
alignment:readقراءة المواءمات ومجموعات الربط.
evidence:readقراءة عبارات الأدلة والتوجيهات.
webhook:manageإدارة اشتراك webhook الخاص بعميلك.

ملاحظة

لعميل الخدمة خمسة نطاقات قراءة، وwebhook:manage لاشتراكاته في الـ webhooks، بمنح صريح لا افتراضي. أي نطاق آخر يرفضه قيد في قاعدة البيانات.

النقاط

كل مسار أدناه مخدوم فعلًا. النسخة v1 في المسار هي نسخة العقد، لا نسخة المنهج.

نقاط القراءة المخدومة
الطريقةالمسارالنطاقالمعنى
GET/v1/academic-levelscurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/alignmentsalignment:readمجموعات الربط بين المناهج ومواءماتها المعتمدة.
GET/v1/associationsassociation:readعلاقات الجراف الداخلية للنسخة.
GET/v1/countriescurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/curriculacurriculum:readسرد المناهج وتفاصيلها مع آخر نسخة منشورة.
GET/v1/curricula/{id}curriculum:readسرد المناهج وتفاصيلها مع آخر نسخة منشورة.
GET/v1/curriculum-typescurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/education-systemscurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/education-systems/{id}/grade-levelscurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/evidenceevidence:readحزمة الأدلة للنتاج: عبارات ومؤشرات وتوجيهات.
GET/v1/framework-domainscurriculum:readالتصنيف: المجالات الكبرى والمجالات والفروع والمعايير.
GET/v1/framework-macroscurriculum:readالتصنيف: المجالات الكبرى والمجالات والفروع والمعايير.
GET/v1/framework-outcomesoutcome:readنتاجات الإطار وتفاصيلها في إصدار.
GET/v1/framework-outcomes/{id}outcome:readنتاجات الإطار وتفاصيلها في إصدار.
GET/v1/framework-standardscurriculum:readالتصنيف: المجالات الكبرى والمجالات والفروع والمعايير.
GET/v1/framework-standards/{id}curriculum:readالتصنيف: المجالات الكبرى والمجالات والفروع والمعايير.
GET/v1/framework-strandscurriculum:readالتصنيف: المجالات الكبرى والمجالات والفروع والمعايير.
GET/v1/framework-versionscurriculum:readإصدارات الإطار (MAJOR.MINOR.PATCH).
GET/v1/frameworkscurriculum:readالأطر العامة وقراءتها بالمعرّف أو الرمز الثابت.
GET/v1/frameworks/applicablecurriculum:readالأطر الصالحة لكل مادة وصف في نظام تعليمي أو دولة، بقاعدة الحسم الملزمة: المخصص للنظام، ثم للدولة، ثم العام.
GET/v1/frameworks/{id}curriculum:readالأطر العامة وقراءتها بالمعرّف أو الرمز الثابت.
GET/v1/grade-levelscurriculum:readالصفوف الدراسية المرجعية للمنهج (غير مُصدَّرة).
GET/v1/mapping-setsalignment:readمجموعات الربط بين المناهج ومواءماتها المعتمدة.
GET/v1/mapping-sets/{id}alignment:readمجموعات الربط بين المناهج ومواءماتها المعتمدة.
GET/v1/outcomesoutcome:readسرد النتاجات وتفاصيلها، مع التثبيت بالنسخة والتوسعة بالمسار.
GET/v1/outcomes/{id}outcome:readسرد النتاجات وتفاصيلها، مع التثبيت بالنسخة والتوسعة بالمسار.
GET/v1/sourcessource:read:metadataبيانات المصادر الوصفية فقط — لا محتوى مرجعي.
GET/v1/sources/{id}source:read:metadataبيانات المصادر الوصفية فقط — لا محتوى مرجعي.
GET/v1/subject-areascurriculum:readالبيانات المرجعية: كل دول العالم، والمناهج، والمواد، والأنظمة التعليمية وصفوفها، والمستويات الأكاديمية — للمزامنة.
GET/v1/versionscurriculum:readنسخ منهج واحد وحالاتها.
GET/v1/webhookswebhook:manageاشتراكات هذا العميل وحده، لا اشتراكات غيره، ولا سرّ.
POST/v1/webhookswebhook:manageاشترك بعنوان https في أحداث؛ سرّ التوقيع في هذا الرد وحده.
DELETE/v1/webhooks/{id}webhook:manageاحذف اشتراكًا؛ لا يُرسل إليه شيء بعدها.
GET/v1/webhooks/{id}webhook:manageاشتراكات هذا العميل وحده، لا اشتراكات غيره، ولا سرّ.
POST/v1/webhooks/{id}/rotate-secretwebhook:manageسرّ توقيع جديد في هذا الرد وحده؛ ويتوقف القديم فورًا.

محجوز في العقد، غير مخدوم

هذه المسارات مسمّاة في العقد لكن لا مسار لها في هذا البناء. لا تستدعها — ستفشل.

  • /v1/subjects
  • /v1/skills
  • /v1/standards
  • /v1/search
  • /v1/exports
  • /v1/diffs
  • /v1/overlays
  • /v1/translations
  • /v1/audit-events
  • /v1/tenants

تثبيت النسخة

مرّر version مع كل قراءة معرفية، أو اترك الحل إلى latest_published — والرد يعيد الرقم الكامل المحلول دائمًا.

الترقيم

القوائم مرقّمة بمؤشر limit/cursor. أغلب القوائم تسمح بـ 100 عنصر في الصفحة، وقوائم المرجع و/v1/frameworks تسمح بـ 200. لا ترقيم صفحات رقمية.

الأخطاء · الحدود