Riferimento API
Le route di automazione, la loro autenticazione e le loro risposte.
Autenticazione
Authorization: Bearer <clé de CI>. Una chiave vale solo per il suo progetto e le sue operazioni; una chiave assente, non valida, revocata o scaduta riceve 401; una route fuori dall’automazione, 403. Le risposte sono in JSON.
Route
| metodo | percorso | operazione | ruolo |
|---|---|---|---|
POST | /import | pousser | importare il piano Dev+Test (il progetto si legge nel piano) |
POST | /runs?p=<projet>&format=json | pousser | risultati di test (JUnit XML, NUnit, TRX, TestNG, Robot, CTest, Cucumber, Behave, Allure, CTRF, TAP o JSON; veda Formato dei risultati) |
POST | /sbom?p=<projet>&version=<v>[&motif=…] | pousser | una SBOM CycloneDX o SPDX; un caricamento diverso diventa una revisione (risposta: revision, nouvelleRevision); motivo facoltativo per la CI, «dépôt de la CI» per impostazione predefinita — veda Correggere senza cancellare |
GET | /livrable?p=<projet> | pousser | lo stato della consegna |
POST | /livrable?p=<projet>&format=json | emettre | emettere una consegna sigillata (version=) |
GET | /livrable/telecharger?no=<numéro> | pousser | il JSON sigillato |
GET | /livrable/certificat?no=<numéro> | pousser | il certificato (&format=pdf: PDF firmato) |
Route pubbliche
| metodo | percorso | ruolo |
|---|---|---|
GET | /livrable/verifier?no=<numéro> | verificare una consegna registrata |
POST | /livrable/verifier | verificare il documento in proprio possesso |
GET | /cle-publique | la chiave pubblica dello spazio |
GET | /api/health | lo stato del servizio, e demarreLe: l’ora di avvio dell’istanza |
GET | /modeles/<fichier> | i modelli: resultats-modele.xml, .tap, .json, plan-modele.json |
GET | /verifier | la pagina di verifica di una consegna, senza account |
Le operazioni di correzione (annullare un caricamento, modificare il piano, registrare un test manuale) non sono aperte alle chiavi CI (403): impegnano una persona, che effettua l’accesso.
Codici
200 successo · 400 richiesta incompleta · 401 chiave rifiutata · 403 fuori dalla portata della chiave (o spazio in sola lettura) · 409 verifica negativa · 413 corpo troppo grande · 422 piano o documento non valido · 503 servizio non configurato (la risposta dice che cosa impostare).