API Laporan SonarQube

Artikel ini menjelaskan cara mengakses laporan keamanan SonarQube yang disimpan di platform Procurize secara programatik. Artikel ini mencakup REST API untuk menampilkan daftar laporan, mengambil laporan, dan mengunduh arsip laporan.

Ikhtisar

Submodul Laporan SonarQube memungkinkan organisasi untuk menyimpan dan mengelola laporan keamanan serta kualitas kode yang dihasilkan oleh SonarQube secara terpusat. Platform Procurize mengekspor data ini melalui:

API REST untuk mengambil metadata tentang laporan yang disimpan
Endpoint untuk mengunduh artefak laporan dalam bentuk arsip ZIP

Kemampuan ini memungkinkan integrasi dengan pipeline CI/CD, sistem GRC, dasbor internal, dan alat manajemen risiko pihak ketiga.

Autentikasi dan Otorisasi

Semua permintaan API yang dijelaskan dalam artikel ini tidak memerlukan autentikasi.

ID Organisasi

ID organisasi diperlukan untuk semua permintaan yang dijelaskan di sini.
Anda dapat menemukannya di panel pengaturan Organisasi pada https://dashboard.procurize.ai.
Perlu dicatat bahwa akses ke panel pengaturan memerlukan otorisasi, dan akses ke panel pengaturan organisasi memerlukan peran pengguna minimal Administrator dalam organisasi tersebut.

Tombol Salin ID

URL Dasar

Semua endpoint REST API disajikan di bawah URL dasar berikut:

https://api.procurize.com

REST API Laporan SonarQube

Daftar Laporan

Mengembalikan daftar laporan keamanan SonarQube yang disimpan di platform secara terpaginasikan.

Endpoint

GET /security/report/list

Parameter Kuery

org (wajib): ID Organisasi.
version (opsional): Versi tepat produk dalam format Semantic Versioning.
minver (opsional): Versi minimum produk dalam format Semantic Versioning.
maxver (opsional): Versi maksimum produk dalam format Semantic Versioning.

Harap dicatat bahwa setidaknya satu dari parameter version, minver, atau maxver wajib disertakan dalam 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"
    }
  ]
}

Unduh Arsip Laporan

Mengunduh arsip ZIP yang berisi semua artefak laporan SonarQube lengkap. Arsip mencakup laporan dalam format HTML dan PDF.

Endpoint

GET /security/report/files

org (wajib): ID Organisasi.
reports (wajib): Array 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 berisi berkas ZIP biner

Klien harus melakukan streaming respons dan menyimpannya ke disk.

Penanganan Kesalahan

API menggunakan kode status HTTP standar.

200 OK: Permintaan berhasil
204 No Content: Laporan tidak ada
400 Bad Request: Parameter tidak valid atau permintaan buruk
500 Internal Server Error: Kesalahan server tak terduga

Respons kesalahan mencakup kode kesalahan yang dapat dibaca mesin serta pesan yang dapat dibaca manusia.

Lihat juga:

Webhooks Laporan SonarQube