SonarQube Raporları API#

Bu makale, Procurize platformunda depolanan SonarQube güvenlik raporlarına programatik olarak nasıl erişileceğini açıklar. Raporları listeleme ve alma ile rapor arşivlerini indirme için REST API’sini kapsar.

Genel Bakış#

SonarQube Raporları alt modülü, kuruluşların SonarQube tarafından oluşturulan güvenlik ve kod kalitesi raporlarını merkezi olarak saklamasına ve yönetmesine olanak tanır. Procurize platformu bu verileri şu yollarla sunar:

  • Depolanan raporların meta verilerini almayı sağlayan bir REST API
  • Rapor artefaktlarını ZIP arşivleri olarak indirmek için bir uç nokta

Bu yetenekler, CI/CD boru hatları, GRC sistemleri, iç panolar ve üçüncü taraf risk yönetimi araçlarıyla entegrasyonları mümkün kılar.

Kimlik Doğrulama ve Yetkilendirme#

Bu makalede açıklanan tüm API istekleri kimlik doğrulama gerektirmez.

Organizasyon ID’si#

Tüm istekler için bir organizasyon ID’si gereklidir.
Bu ID’yi Organizasyonun ayarlar paneli’nde https://dashboard.procurize.ai adresinden bulabilirsiniz.
Lütfen ayarlar paneline erişimin yetkilendirme gerektirdiğini ve organizasyon ayar paneline erişimin, o organizasyonda en az Yönetici rolüne sahip bir kullanıcı gerektirdiğini unutmayın.

ID Kopyala düğmesi

Temel URL#

Tüm REST API uç noktaları aşağıdaki temel URL altında sunulur:

https://api.procurize.com

SonarQube Raporları REST API#

Raporları Listele#

Platformda depolanan SonarQube güvenlik raporlarının sayfalı bir listesini alır.

Endpoint

GET /security/report/list

Sorgu Parametreleri

  • org (gerekli): Organizasyon ID’si.
  • version (isteğe bağlı): Ürünlerin Semantic Versioning formatındaki kesin sürümü.
  • minver (isteğe bağlı): Ürünlerin Semantic Versioning formatındaki minimum sürümü.
  • maxver (isteğe bağlı): Ürünlerin Semantic Versioning formatındaki maksimum sürümü.

Lütfen istek için version, minver veya maxver parametrelerinden en az birinin gerekliliğine dikkat edin.

İstek Örneği

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

Yanıt Örneği

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

Rapor Arşivi İndir#

Tam SonarQube rapor artefaktlarını içeren bir ZIP arşivini indirir. Arşiv HTML ve PDF raporlarını içerir.

Endpoint

GET /security/report/files
  • org (gerekli): Organizasyon ID’si.
  • reports (gerekli): Rapor ID’lerinin dizisi.

İstek Örneği

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"

Yanıt

  • İçerik Türü: application/zip
  • Yanıt gövdesi ikili ZIP dosyasını içerir

İstemciler yanıtı akıtmalı ve diske kaydetmelidir.

Hata İşleme#

API standart HTTP durum kodlarını kullanır.

  • 200 OK: İstek başarılı
  • 204 No Content: Rapor mevcut değil
  • 400 Bad Request: Geçersiz parametreler veya hatalı istek
  • 500 Internal Server Error: Beklenmeyen sunucu hatası

Hata yanıtları makine tarafından okunabilir bir hata kodu ve insan tarafından okunabilir bir mesaj içerir.

İlgili Bağlantılar:#

İlgili makaleler#

Güvenlik Raporları Nedir?

Güvenlik raporları deposu

Güvenlik Raporlarını Nasıl Yapılandırılır

En Üste
Dil seç