مرجع API
مسارات الأتمتة، ومصادقتها، وردودها.
المصادقة
Authorization: Bearer <clé de CI>. المفتاح صالح لمشروعه وعملياته فقط؛ المفتاح الغائب، أو غير الصالح، أو الملغى، أو المنتهي الصلاحية يتلقى 401؛ والمسار الخارج عن الأتمتة، 403. الردود بصيغة JSON.
المسارات
| الطريقة | المسار | العملية | الدور |
|---|---|---|---|
POST | /import | pousser | استيراد خطة التطوير والاختبار (يُقرأ المشروع من الخطة) |
POST | /runs?p=<projet>&format=json | pousser | نتائج اختبارات (JUnit XML، NUnit، TRX، TestNG، Robot، CTest، Cucumber، Behave، Allure، CTRF، TAP أو JSON؛ انظر صيغة النتائج) |
POST | /sbom?p=<projet>&version=<v>[&motif=…] | pousser | قائمة SBOM بصيغة CycloneDX أو SPDX؛ الإيداع المختلف يصبح مراجعة (الرد: revision، nouvelleRevision)؛ السبب اختياري لنظام CI، وقيمته الافتراضية «dépôt de la CI» (إيداع نظام CI) — انظر التصحيح دون محو |
GET | /livrable?p=<projet> | pousser | حالة المُسلَّم |
POST | /livrable?p=<projet>&format=json | emettre | إصدار مُسلَّم مختوم (version=) |
GET | /livrable/telecharger?no=<numéro> | pousser | ملف JSON المختوم |
GET | /livrable/certificat?no=<numéro> | pousser | الشهادة (&format=pdf: ملف PDF موقَّع) |
المسارات العامة
| الطريقة | المسار | الدور |
|---|---|---|
GET | /livrable/verifier?no=<numéro> | التحقق من مُسلَّم مسجَّل |
POST | /livrable/verifier | التحقق من الوثيقة التي بحوزتك |
GET | /cle-publique | المفتاح العام للفضاء |
GET | /api/health | حالة الخدمة، وdemarreLe: وقت بدء تشغيل النسخة |
GET | /modeles/<fichier> | النماذج: resultats-modele.xml، .tap، .json، plan-modele.json |
GET | /verifier | صفحة التحقق من مُسلَّم، دون حساب |
إجراءات التصحيح (إلغاء إيداع، تعديل الخطة، إدخال اختبار يدوي) ليست متاحة لمفاتيح CI (403): فهي تُلزم شخصًا، يسجّل دخوله.
الرموز
200 نجاح · 400 طلب ناقص · 401 مفتاح مرفوض · 403 خارج نطاق المفتاح (أو فضاء للقراءة فقط) · 409 تحقق سلبي · 413 متن كبير جدًا · 422 خطة أو وثيقة غير صالحة · 503 خدمة غير مهيّأة (يبيّن الرد ما يجب ضبطه).