API-ul de Rapoarte SonarQube

Acest articol descrie cum să accesați programatic rapoartele de securitate SonarQube stocate în platforma Procurize. Acoperă API‑ul REST pentru listarea și preluarea rapoartelor și descărcarea arhivelor de rapoarte.

Prezentare generală

Submodulul Rapoarte SonarQube permite organizațiilor să stocheze și să gestioneze centralizat rapoartele de securitate și calitate a codului generate de SonarQube. Platforma Procurize expune aceste date prin:

  • Un API REST pentru preluarea metadatelor despre rapoartele stocate
  • Un punct final pentru descărcarea artefactelor de raport ca arhive ZIP

Aceste capabilități permit integrarea cu pipeline‑uri CI/CD, sisteme GRC, dashboard‑uri interne și instrumente terțe de management al riscurilor.

Autentificare și autorizare

Toate cererile API descrise în acest articol nu necesită autentificare.

ID-ul organizației

Un ID de organizație este necesar pentru toate cererile descrise aici.
Îl puteți găsi în panoul de setări al organizației la https://dashboard.procurize.ai.
Rețineți că accesul la panoul de setări necesită autorizare, iar accesul la setările unei organizații necesită un rol de utilizator de cel puțin Administrator în acea organizație.

Buton Copiere ID

URL de bază

Toate punctele finale ale API‑ului REST sunt servite sub următorul URL de bază:

https://api.procurize.com

API REST pentru Rapoarte SonarQube

Listarea rapoartelor

Recuperează o listă paginată de rapoarte de securitate SonarQube stocate în platformă.

Punct final

GET /security/report/list

Parametri de interogare

  • org (obligatoriu): ID-ul organizației.
  • version (opțional): Versiunea exactă a produselor, în formatul Semantic Versioning.
  • minver (opțional): Versiunea minimă a produselor, în formatul Semantic Versioning.
  • maxver (opțional): Versiunea maximă a produselor, în formatul Semantic Versioning.

Rețineți că pentru cerere este necesar cel puțin unul dintre parametrii version, minver sau maxver.

Exemplu de solicitare

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

Exemplu de răspuns

{
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "reports": [
    {
      "projectName": "Produs test",
      "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"
    }
  ]
}

Descărcarea arhivei de raport

Descarcă o arhivă ZIP care conține toate artefactele complete ale raportului SonarQube. Arhiva include rapoarte în format HTML și PDF.

Punct final

GET /security/report/files
  • org (obligatoriu): ID-ul organizației.
  • reports (obligatoriu): Tabla cu ID‑urile rapoartelor.

Exemplu de solicitare

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"

Răspuns

  • Content‑Type: application/zip
  • Corpul răspunsului conține fișierul ZIP binar

Clienții trebuie să stream răspunsul și să îl salveze pe disc.

Gestionarea erorilor

API‑ul utilizează codurile standard de stare HTTP.

  • 200 OK: Cerere reușită
  • 204 No Content: Raportul nu există
  • 400 Bad Request: Parametri invalizi sau cerere malformată
  • 500 Internal Server Error: Eroare neașteptată a serverului

Răspunsurile de eroare includ un cod de eroare mașină‑citibil și un mesaj pentru utilizator.

Vezi și:

Articole conexe

Ce sunt rapoartele de securitate?

Depozitul rapoartelor de securitate

Cum se configurează rapoartele de securitate

Sus
Selectaţi limba