SonarQube jelentések API

Ez a cikk leírja, hogyan lehet programozott módon hozzáférni a Procurize platformon tárolt SonarQube biztonsági jelentésekhez. Bemutatja a REST API-t a jelentések listázásához, lekérdezéséhez és a jelentésarchívumok letöltéséhez.

Áttekintés

A SonarQube jelentések almodul lehetővé teszi a szervezetek számára, hogy központilag tárolják és kezeljék a SonarQube által generált biztonsági és kódfelülvizsgálati jelentéseket. A Procurize platform a következő módon teszi elérhetővé ezeket az adatokat:

Egy REST API a tárolt jelentések metaadatainak lekérdezéséhez
Egy végpont a jelentés‑artifactumok ZIP archívumként történő letöltéséhez

Ezek a képességek integrációkat tesznek lehetővé CI/CD folyamatokkal, GRC rendszerekkel, belső műszerfalakkal és harmadik fél kockázatkezelő eszközökkel.

Hitelesítés és jogosultság

Az ebben a cikkben leírt API‑kérésekhez nem szükséges hitelesítés.

Szervezet azonosító

Egy szervezet azonosító szükséges minden itt leírt kéréshez.
Megtalálható a szervezet beállítási paneljén a https://dashboard.procurize.ai címen.
Kérjük vegye figyelembe, hogy a beállítási panel eléréséhez jogosultság szükséges, és a szervezet beállítási paneljéhez csak legalább „Adminisztrátor” szerepkörrel rendelkező felhasználó férhet hozzá.

Másolás azonosító gomb

Alap URL

Minden REST API végpont az alábbi alap URL alatt érhető el:

https://api.procurize.com

SonarQube jelentések REST API

Jelentések listázása

Lekér egy oldalonkénti listát a platformon tárolt SonarQube biztonsági jelentésekről.

Végpont

GET /security/report/list

Lekérdezési paraméterek

org (kötelező): Szervezet azonosító.
version (opcionális): A termékek pontos verziója a szemantikus verziózás formátumban.
minver (opcionális): A termékek minimális verziója a szemantikus verziózás formátumban.
maxver (opcionális): A termékek maximális verziója a szemantikus verziózás formátumban.

Felhívjuk a figyelmet, hogy a kéréshez legalább az version, minver vagy maxver paraméterek közül egy kötelező.

Példa kérés

curl "https://api.procurize.com/security/report/list?org=00000000-0000-0000-0000-000000000001&version=1.0"

Válasz példa

{
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "reports": [
    {
      "projectName": "Test product",
      "id": "00000000-0000-0000-0000-000000000002",
      "reportType": "CWE Top 25",
      "reportVersion": 2024,
      "projectVersion": "1.0",
      "date": "2025-12-17T09:05:48.5946432+00:00",
      "uploadDate": "2025-12-17T09:05:48.5946432+00:00",
      "vulnerabilitiesCount": 0,
      "securityRating": "A"
    }
  ]
}

Jelentésarchívum letöltése

Letölt egy ZIP archívumot, amely a teljes SonarQube jelentés‑artifactumokat tartalmazza. Az archívum HTML és PDF jelentéseket is magában foglal.

Végpont

GET /security/report/files

org (kötelező): Szervezet azonosító.
reports (kötelező): Jelentés‑azonosítók tömbje.

Példa kérés

curl "https://api.procurize.com/security/report/files?org=00000000-0000-0000-0000-000000000001&reports=00000000-0000-0000-0000-000000000002&reports=00000000-0000-0000-0000-000000000003"

Válasz

Content-Type: application/zip
A válasz törzse a bináris ZIP fájlt tartalmazza

A kliensnek a választ stream‑elni és lemezre menteni kell.

Hiba kezelés

Az API a szabványos HTTP státuszkódokat használja.

200 OK: Kérés sikeres
204 No Content: A jelentés nem létezik
400 Bad Request: Érvénytelen paraméterek vagy hibás kérés
500 Internal Server Error: Váratlan szerverhiba

A hibaválaszok gép‑olvasható hibakódot és ember‑olvasható üzenetet tartalmaznak.

Lásd még:

SonarQube jelentések webhookok

Kapcsolódó cikkek

Mi a biztonsági jelentés?

Biztonsági jelentések tárhely

Hogyan konfiguráljuk a biztonsági jelentéseket