QATrax
View as Markdown

API reference

The automation routes, their authentication and their responses.


Authentication

Authorization: Bearer <CI key>. A key is valid only for its project and its operations; a missing, invalid, revoked or expired key receives 401; a route outside automation, 403. Responses are in JSON.

Routes

methodpathoperationrole
POST/importpousserimport the Dev+Test plan (the project is read from the plan)
POST/runs?p=<project>&format=jsonpoussertest results (JUnit XML, NUnit, TRX, TestNG, Robot, CTest, Cucumber, Behave, Allure, CTRF, TAP or JSON; see Test results format)
POST/sbom?p=<project>&version=<v>[&motif=…]poussera CycloneDX or SPDX SBOM; a different upload becomes a revision (response: revision, nouvelleRevision); reason optional for the CI, dépôt de la CI ("CI upload") by default — see Correct without erasing
GET/livrable?p=<project>pousserthe state of the deliverable
POST/livrable?p=<project>&format=jsonemettreissue a sealed deliverable (version=)
GET/livrable/telecharger?no=<number>pousserthe sealed JSON
GET/livrable/certificat?no=<number>pousserthe certificate (&format=pdf: signed PDF)

Public routes

methodpathrole
GET/livrable/verifier?no=<number>verify a recorded deliverable
POST/livrable/verifierverify the document you hold
GET/cle-publiquethe public key of the space
GET/api/healththe state of the service, and demarreLe: the start time of the instance
GET/modeles/<file>the templates: resultats-modele.xml, .tap, .json, plan-modele.json
GET/verifierthe page for verifying a deliverable, without an account

Correction actions (cancelling an upload, changing the plan, entering a manual test) are not open to CI keys (403): they commit a person, who signs in.

Codes

200 success · 400 incomplete request · 401 key refused · 403 outside the key's scope (or space in read-only mode) · 409 negative verification · 413 body too large · 422 invalid plan or document · 503 service not configured (the response says what to set).