API Laporan SonarQube

Artikel ini menjelaskan cara mengakses laporan keselamatan SonarQube secara programatik yang disimpan di platform Procurize. Ia merangkumi API REST untuk menyenaraikan, mendapatkan laporan dan memuat turun arkib laporan.

Gambaran Keseluruhan

Submodul Laporan SonarQube membolehkan organisasi menyimpan dan mengurus laporan keselamatan serta kualiti kod yang dijana oleh SonarQube secara berpusat. Platform Procurize memaparkan data ini melalui:

API REST untuk memperoleh metadata mengenai laporan yang disimpan
Titik akhir untuk memuat turun artifak laporan dalam bentuk arkib ZIP

Keupayaan ini membolehkan integrasi dengan pipeline CI/CD, sistem GRC, papan pemuka dalaman, dan alat pengurusan risiko pihak ketiga.

Pengesahan dan Kebenaran

Semua permintaan API yang diterangkan dalam artikel ini tidak memerlukan pengesahan.

ID Organisasi

ID organisasi diperlukan untuk semua permintaan yang diterangkan di sini.
Anda boleh menemuinya pada panel tetapan Organisasi di https://dashboard.procurize.ai.
Sila ambil perhatian bahawa akses ke panel tetapan memerlukan kebenaran, dan akses ke panel tetapan organisasi memerlukan peranan pengguna sekurang‑kurangnya Pentadbir dalam organisasi tersebut.

Butang Salin ID

URL Asas

Semua titik akhir API REST disajikan di bawah URL asas berikut:

https://api.procurize.com

API REST Laporan SonarQube

Senarai Laporan

Mendapatkan senarai berhalaman laporan keselamatan SonarQube yang disimpan di platform.

Titik Akhir

GET /security/report/list

Parameter Pertanyaan

org (wajib): ID organisasi.
version (pilihan): Versi tepat produk dalam format Penomoran Semantik.
minver (pilihan): Versi minimum produk dalam format Penomoran Semantik.
maxver (pilihan): Versi maksimum produk dalam format Penomoran Semantik.

Sila ambil perhatian bahawa sekurang‑kurangnya satu daripada parameter version, minver atau maxver diperlukan untuk permintaan.

Contoh Permintaan

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

Contoh Respons

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

Muat Turun Arkib Laporan

Muat turun arkib ZIP yang mengandungi semua artifak laporan SonarQube. Arkib tersebut termasuk laporan dalam format HTML dan PDF.

Titik Akhir

GET /security/report/files

org (wajib): ID organisasi.
reports (wajib): Senarai ID laporan.

Contoh Permintaan

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
Badan respons mengandungi fail ZIP binari

Klien harus menstrim respons dan menyimpan ke cakera.

Pengendalian Ralat

API menggunakan kod status HTTP standard.

200 OK: Permintaan berhasil
204 No Content: Laporan tidak wujud
400 Bad Request: Parameter tidak sah atau permintaan rosak
500 Internal Server Error: Ralat pelayan tidak dijangka

Respons ralat termasuk kod ralat yang boleh dibaca mesin dan mesej yang boleh dibaca manusia.

Lihat juga:

SonarQube Reports Webhooks

Artikel Berkaitan

Apakah Laporan Keselamatan?

Repositori laporan keselamatan

Cara Menyediakan Laporan Keselamatan