SonarQube izvješća API

Ovaj članak opisuje kako programski pristupiti SonarQube sigurnosnim izvješćima pohranjenim na Prokurize platformi. Pokriva REST API za izlistavanje i dohvaćanje izvješća te preuzimanje arhiva izvješća.

Pregled

Podmodul SonarQube izvješća omogućuje organizacijama središnje pohranjivanje i upravljanje sigurnosnim i kvalitetnim izvješćima koda generiranim od strane SonarQube-a. Prokurize platforma izlaže ove podatke putem:

  • REST API-ja za dohvaćanje metapodataka o pohranjenim izvješćima
  • Krajnje točke za preuzimanje artefakata izvješća kao ZIP arhiva

Ove mogućnosti omogućuju integracije s CI/CD procesima, GRC sustavima, internim nadzornim pločama i alatima za upravljanje rizicima trećih strana.

Autentikacija i autorizacija

Sve API zahtjeve opisane u ovom članku nije potrebno autentificirati.

ID organizacije

ID organizacije je potreban za sve zahtjeve opisane ovdje.
Možete ga pronaći u panelu postavki organizacije na https://dashboard.procurize.ai.
Imajte na umu da pristup panelu postavki zahtijeva odobrenje, a pristup panelu postavki organizacije zahtijeva korisničku ulogu najmanje Administrator unutar te organizacije.

Gumb Kopiraj ID

Osnovni URL

Svi REST API krajnji točke posluživaju se pod sljedećim osnovnim URL‑om:

https://api.procurize.com

SonarQube izvješća REST API

Izlistaj izvješća

Dohvaća paginiranu listu SonarQube sigurnosnih izvješća pohranjenih na platformi.

Krajnja točka

GET /security/report/list

Parametri upita

  • org (obavezno): ID organizacije.
  • version (neobavezno): Točna verzija proizvoda u obliku Semantic Versioning.
  • minver (neobavezno): Minimalna verzija proizvoda u obliku Semantic Versioning.
  • maxver (neobavezno): Maksimalna verzija proizvoda u obliku Semantic Versioning.

Napomena: za zahtjev je obavezan barem jedan od parametara version, minver ili maxver.

Primjer zahtjeva

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

Primjer odgovora

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

Preuzmi arhivu izvješća

Preuzima ZIP arhivu koja sadrži kompletne artefakte SonarQube izvješća. Arhiva uključuje HTML i PDF izvješća.

Krajnja točka

GET /security/report/files
  • org (obavezno): ID organizacije.
  • reports (obavezno): Polje ID‑ova izvješća.

Primjer zahtjeva

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"

Odgovor

  • Content-Type: application/zip
  • Tijelo odgovora sadrži binarnu ZIP datoteku

Klijenti bi trebali streamati odgovor i spremiti ga na disk.

Rukovanje pogreškama

API koristi standardne HTTP kodove statusa.

  • 200 OK: Zahtjev je uspješan
  • 204 No Content: Izvješće ne postoji
  • 400 Bad Request: Neispravni parametri ili loše oblikovan zahtjev
  • 500 Internal Server Error: Neočekivana greška na poslužitelju

Odgovori na greške uključuju kod greške koji je strojno čitljiv i poruku koja je čitljiva čovjeku.

Vidi također:

Povezani članci

Što su sigurnosna izvješća?

Spremište sigurnosnih izvješća

Kako konfigurirati sigurnosna izvješća

na vrh
Odaberite jezik