API zpráv SonarQube

Tento článek popisuje, jak programaticky přistupovat k bezpečnostním zprávám SonarQube uloženým na platformě Procurize. Pokrývá REST API pro výpis, získávání zpráv a stahování archivů zpráv.

Přehled

Podmodul SonarQube Reports umožňuje organizacím centrálně ukládat a spravovat bezpečnostní a kvalitativní zprávy o kódu generované SonarQube. Platforma Procurize tato data zpřístupňuje prostřednictvím:

REST API pro získávání metadat o uložených zprávách
koncového bodu pro stahování artefaktů zpráv jako ZIP archivů

Tato funkčnost umožňuje integraci s CI/CD pipeline, systémy GRC, interními řídicími panely a nástroji pro řízení rizik třetích stran.

Autentizace a autorizace

Všechny požadavky API popsané v tomto článku nevyžadují autentizaci.

ID organizace

ID organizace je vyžadováno pro všechny zde popsané požadavky.
Naleznete jej v nastavení organizace na https://dashboard.procurize.ai.
Všimněte si, že přístup k panelu nastavení vyžaduje oprávnění a přístup k nastavení organizace vyžaduje roli uživatele alespoň Administrátor v dané organizaci.

Tlačítko Kopírovat ID

Základní URL

Všechny koncové body REST API jsou k dispozici pod následující základní URL:

https://api.procurize.com

REST API SonarQube Reports

Vypsat zprávy

Vrací stránkovaný seznam bezpečnostních zpráv SonarQube uložených na platformě.

Koncový bod

GET /security/report/list

Parametry dotazu

org (povinné): ID organizace.
version (volitelné): Přesná verze produktů ve formátu Semantic Versioning.
minver (volitelné): Minimální verze produktů ve formátu Semantic Versioning.
maxver (volitelné): Maximální verze produktů ve formátu Semantic Versioning.

Všimněte si, že alespoň jeden z parametrů version, minver nebo maxver je pro požadavek povinný.

Příklad požadavku

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

Příklad odpovědi

{
  "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"
    }
  ]
}

Stáhnout archiv zprávy

Stáhne ZIP archiv obsahující kompletní artefakty zprávy SonarQube. Archiv zahrnuje HTML a PDF zprávy.

Koncový bod

GET /security/report/files

org (povinné): ID organizace.
reports (povinné): Pole ID zpráv.

Příklad požadavku

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"

Odpověď

Content-Type: application/zip
Tělo odpovědi obsahuje binární ZIP soubor

Klienti by měli streamovat odpověď a uložit ji na disk.

Zpracování chyb

API používá standardní HTTP stavové kódy.

200 OK: Požadavek úspěšný
204 No Content: Zpráva neexistuje
400 Bad Request: Neplatné parametry nebo nesprávný požadavek
500 Internal Server Error: Neočekávaná chyba serveru

Odpovědi s chybou obsahují strojově čitelný kód chyby a lidsky čitelnou zprávu.