SonarQube-rapporten API

Dit artikel beschrijft hoe u programmatisch toegang krijgt tot SonarQube‑beveiligingsrapporten die zijn opgeslagen op het Procurize‑platform. Het behandelt de REST‑API voor het opsommen en ophalen van rapporten en het downloaden van rapportarchieven.

Overzicht

De SonarQube‑rapporten‑submodule stelt organisaties in staat beveiligings‑ en code‑kwaliteitsrapporten die door SonarQube zijn gegenereerd centraal op te slaan en te beheren. Het Procurize‑platform maakt deze gegevens beschikbaar via:

  • Een REST‑API voor het ophalen van metadata over opgeslagen rapporten
  • Een endpoint voor het downloaden van rapportartefacten als ZIP‑archieven

Deze mogelijkheden maken integraties met CI/CD‑pijplijnen, GRC‑systemen, interne dashboards en tools voor risicobeheer van derden mogelijk.

Authenticatie en autorisatie

Alle API‑verzoeken die in dit artikel worden beschreven, vereisen geen authenticatie.

Organisatie‑ID

Een organisatie‑ID is vereist voor alle hier beschreven verzoeken.
U vindt deze in het instellingenpaneel van de organisatie op https://dashboard.procurize.ai.
Houd er rekening mee dat toegang tot het instellingenpaneel autorisatie vereist, en dat toegang tot het instellingenpaneel van de organisatie een gebruiker met ten minste de rol Administrator in die organisatie nodig heeft.

Kopieer ID-knop

Basis‑URL

Alle REST‑API‑endpoints worden aangeboden onder de volgende basis‑URL:

https://api.procurize.com

SonarQube-rapporten REST‑API

Rapporten opsommen

Haalt een gepagineerde lijst op van SonarQube‑beveiligingsrapporten die in het platform zijn opgeslagen.

Endpoint

GET /security/report/list

Query‑parameters

  • org (verplicht): Organisatie‑ID.
  • version (optioneel): De exacte versie van de producten in het Semantic Versioning‑formaat.
  • minver (optioneel): De minimumversie van de producten in het Semantic Versioning‑formaat.
  • maxver (optioneel): De maximumversie van de producten in het Semantic Versioning‑formaat.

Let op: ten minste één van de parameters version, minver of maxver is vereist voor het verzoek.

Voorbeeldverzoek

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

Voorbeeldrespons

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

Rapport‑archief downloaden

Downloadt een ZIP‑archief dat alle SonarQube‑rapportartefacten bevat. Het archief bevat HTML‑ en PDF‑rapporten.

Endpoint

GET /security/report/files
  • org (verplicht): Organisatie‑ID.
  • reports (verplicht): Array van rapport‑ID’s.

Voorbeeldverzoek

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"

Respons

  • Content‑Type: application/zip
  • De respons‑body bevat het binaire ZIP‑bestand

Clients dienen de respons te streamen en op schijf op te slaan.

Foutafhandeling

De API gebruikt standaard HTTP‑statuscodes.

  • 200 OK: Verzoek geslaagd
  • 204 No Content: Rapport bestaat niet
  • 400 Bad Request: Ongeldige parameters of verkeerd opgesteld verzoek
  • 500 Internal Server Error: Onverwachte serverfout

Foutresponsen bevatten een machinale foutcode en een leesbare melding.

Zie ook:

Gerelateerde artikelen

Wat zijn beveiligingsrapporten?

Beveiligingsrapporten‑repository

Hoe beveiligingsrapporten te configureren

Naar boven
Selecteer taal