API pre reporty SonarQube

Tento článok popisuje, ako programaticky pristupovať k bezpečnostným reportom SonarQube uloženým v platforme Procurize. Pokrýva REST API na výpis a získavanie reportov a sťahovanie archívov reportov.

Prehľad

Podmodul SonarQube Reports umožňuje organizáciám centrálne ukladať a spravovať bezpečnostné a kvalitatívne reporty kódu generované SonarQube. Platforma Procurize vystavuje tieto dáta prostredníctvom:

REST API na získavanie metadát o uložených reportoch
Koncový bod na sťahovanie artefaktov reportov ako ZIP archívy

Tieto schopnosti umožňujú integráciu s CI/CD pipeline, GRC systémami, internými dashboardmi a nástrojmi na riadenie rizík tretích strán.

Autentifikácia a autorizácia

Všetky API požiadavky opísané v tomto článku nevyžadujú autentifikáciu.

ID organizácie

ID organizácie je vyžadované pre všetky požiadavky popísané tu. Nájdete ho v nastavovacom paneli organizácie na https://dashboard.procurize.ai.

Všimnite si, že prístup k nastaveniam vyžaduje autorizáciu a prístup k nastaveniam organizácie požaduje používateľskú rolu aspoň Administrátor v danej organizácii.

Tlačidlo Kopírovať ID

Základná URL

Všetky koncové body REST API sú dostupné pod nasledujúcou základnou URL:

https://api.procurize.com

SonarQube Reports REST API

Zoznam reportov

Vráti stránkovaný zoznam bezpečnostných reportov SonarQube uložených v platforme.

Endpoint

GET /security/report/list

Query Parameters

org (povinné): ID organizácie.
version (voliteľné): Presná verzia produktov vo formáte Semantic Versioning.
minver (voliteľné): Minimálna verzia produktov vo formáte Semantic Versioning.
maxver (voliteľné): Maximálna verzia produktov vo formáte Semantic Versioning.

Všimnite si, že aspoň jeden z parametrov version, minver alebo maxver je pre požiadavku povinný.

Request Example

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

Response Example

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

Stiahnuť archív reportu

Stiahne ZIP archív obsahujúci kompletné artefakty reportu SonarQube. Archív obsahuje HTML a PDF reporty.

Endpoint

GET /security/report/files

org (povinné): ID organizácie.
reports (povinné): Pole ID reportov.

Request Example

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"

Response

Content-Type: application/zip
Telo odpovede obsahuje binárny ZIP súbor

Klienti by mali streamovať odpoveď a uložiť ju na disk.

Riešenie chýb

API používa štandardné HTTP stavové kódy.

200 OK: Požiadavka úspešná
204 No Content: Report neexistuje
400 Bad Request: Neplatné parametre alebo chybná požiadavka
500 Internal Server Error: Neočakávaná chyba servera

Chybové odpovede obsahujú strojovo čitateľný kód chyby a ľudsky čitateľnú správu.

Pozri tiež:

Webhooky pre SonarQube Reporty

Súvisiace články

Čo sú bezpečnostné reporty?

Repozitár bezpečnostných reportov

Ako konfigurovať bezpečnostné reporty