API-Referenz
Die Automatisierungsrouten, ihre Authentifizierung und ihre Antworten.
Authentifizierung
Authorization: Bearer <clé de CI>. Ein Schlüssel gilt nur für sein Projekt und seine Operationen; ein fehlender, ungültiger, widerrufener oder abgelaufener Schlüssel erhält 401; eine Route außerhalb der Automatisierung 403. Die Antworten sind in JSON.
Routen
| Methode | Pfad | Operation | Zweck |
|---|---|---|---|
POST | /import | pousser | den Dev+Test-Plan importieren (das Projekt wird aus dem Plan gelesen) |
POST | /runs?p=<projet>&format=json | pousser | Testergebnisse (JUnit XML, NUnit, TRX, TestNG, Robot, CTest, Cucumber, Behave, Allure, CTRF, TAP oder JSON; siehe Format der Ergebnisse) |
POST | /sbom?p=<projet>&version=<v>[&motif=…] | pousser | eine SBOM in CycloneDX oder SPDX; ein abweichendes Hochladen wird zu einer Revision (Antwort: revision, nouvelleRevision); Grund für die CI optional, standardmäßig „dépôt de la CI“ — siehe Korrigieren ohne zu löschen |
GET | /livrable?p=<projet> | pousser | der Stand des Lieferobjekts |
POST | /livrable?p=<projet>&format=json | emettre | ein versiegeltes Lieferobjekt ausstellen (version=) |
GET | /livrable/telecharger?no=<numéro> | pousser | das versiegelte JSON |
GET | /livrable/certificat?no=<numéro> | pousser | das Zertifikat (&format=pdf: signiertes PDF) |
Öffentliche Routen
| Methode | Pfad | Zweck |
|---|---|---|
GET | /livrable/verifier?no=<numéro> | ein gespeichertes Lieferobjekt prüfen |
POST | /livrable/verifier | das Dokument prüfen, das man besitzt |
GET | /cle-publique | der öffentliche Schlüssel des Bereichs |
GET | /api/health | der Zustand des Dienstes, und demarreLe: die Startzeit der Instanz |
GET | /modeles/<fichier> | die Vorlagen: resultats-modele.xml, .tap, .json, plan-modele.json |
GET | /verifier | die Seite zur Prüfung eines Lieferobjekts, ohne Konto |
Die Korrekturhandlungen (ein Hochladen stornieren, den Plan ändern, einen manuellen Test erfassen) stehen den CI-Schlüsseln nicht offen (403): Sie verpflichten eine Person, die sich anmeldet.
Codes
200 Erfolg · 400 unvollständige Anfrage · 401 Schlüssel abgelehnt · 403 außerhalb der Reichweite des Schlüssels (oder Bereich schreibgeschützt) · 409 negative Prüfung · 413 Body zu groß · 422 Plan oder Dokument ungültig · 503 Dienst nicht konfiguriert (die Antwort sagt, was zu setzen ist).