SonarQube-raporttien API

Tämä artikkeli kuvaa, miten ohjelmallisesti käyttää SonarQube‑turvallisuusraportteja, jotka on tallennettu Procurize‑alustalle. Se kattaa REST‑API:n raporttien listaamiseen, hakemiseen ja arkistojen lataamiseen.

Yleiskatsaus

SonarQube‑raporttien alimoduuli mahdollistaa organisaatioille turvallisuus- ja koodinlaaturaporttien keskitetyn tallennuksen ja hallinnan, jotka SonarQube tuottaa. Procurize‑alusta tarjoaa nämä tiedot seuraavien kautta:

REST‑API metatietojen hakemiseen tallennetuista raporteista
Päätepiste ZIP‑arkistojen lataamiseksi

Nämä ominaisuudet mahdollistavat integraatiot CI/CD‑putkistoihin, GRC‑järjestelmiin, sisäisiin koontinäyttöihin sekä kolmannen osapuolen riskienhallintatyökaluihin.

Tunnistautuminen ja valtuutus

Kaikki tässä artikkelissa kuvattavat API‑pyynnöt eivät vaadi tunnistautumista.

Organisaation ID

Organisaation ID on pakollinen kaikissa tässä kuvatuissa pyynnöissä. Löydät sen Organisaation asetuspaneelista osoitteessa https://dashboard.procurize.ai. Huomaa, että asetuspaneelin käyttö edellyttää valtuutusta, ja organisaation asetuksiin pääsy vaatii vähintään Järjestelmänvalvoja‑roolin kyseisessä organisaatiossa.

Kopioi ID -painike

Perus-URL

Kaikki REST‑API‑päätepisteet sijaitsevat seuraavan perus‑URL:n alla:

https://api.procurize.com

SonarQube‑raporttien REST‑API

Raporttien listaaminen

Hakee sivutetun luettelon SonarQube‑turvallisuusraporteista, jotka on tallennettu alustalle.

Päätepiste

GET /security/report/list

Kyselyparametrit

org (pakollinen): Organisaation ID.
version (valinnainen): Tuotteiden tarkka versio Semantic Versioning -muodossa.
minver (valinnainen): Tuotteiden vähimmäisversio Semantic Versioning -muodossa.
maxver (valinnainen): Tuotteiden enimmäisversio Semantic Versioning -muodossa.

Huomaa, että ainakin yksi parametreista version, minver tai maxver on pakollinen pyynnölle.

Pyynnön esimerkki

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

Vastauksen esimerkki

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

Raporttiarkiston lataaminen

Lataa ZIP‑arkiston, joka sisältää koko SonarQube‑raportin artefaktit. Arkisto sisältää HTML‑ ja PDF‑raportit.

Päätepiste

GET /security/report/files

org (pakollinen): Organisaation ID.
reports (pakollinen): Raporttien ID‑lista (taulukko).

Pyynnön esimerkki

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"

Vastaus

Content-Type: application/zip
Vastausrunko sisältää binaarisen ZIP‑tiedoston

Asiakkaiden tulisi suoratoistaa vastaus ja tallentaa se levylle.

Virheenkäsittely

API käyttää standardeja HTTP‑statuskoodeja.

200 OK: Pyyntö onnistui
204 No Content: Raporttia ei ole olemassa
400 Bad Request: Virheelliset parametrit tai väärin muotoiltu pyyntö
500 Internal Server Error: Odottamaton palvelinvirhe

Virhesvastaus sisältää koneellisesti luettavan virhekoodin ja ihmisluettavan viestin.

Katso myös:

SonarQube‑raporttien webhookit

Aiheeseen liittyvät artikkelit

Mitkä ovat turvallisuusraportit?

Turvallisuusraporttien arkisto

Miten määrittää turvallisuusraportit