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 | 一份 CycloneDX 或 SPDX 格式的 SBOM;不同的上传成为一次修订(响应: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 服务未配置(响应会说明需要设置什么)。