SonarQube रिपोर्ट्स API

यह लेख बताता है कि कैसे प्रोग्रामेटिकली Procurize प्लेटफ़ॉर्म में संग्रहीत SonarQube सुरक्षा रिपोर्ट्स तक पहुंचें। यह रिपोर्ट्स की सूची, प्राप्ति और रिपोर्ट अभिलेख डाउनलोड करने के लिए REST API को कवर करता है।

अवलोकन

SonarQube रिपोर्ट्स सबमॉड्यूल संगठनों को SonarQube द्वारा उत्पन्न सुरक्षा और कोड गुणवत्ता रिपोर्ट्स को केंद्रीकृत रूप से संग्रहीत और प्रबंधित करने की अनुमति देता है। Procurize प्लेटफ़ॉर्म इस डेटा को निम्नलिखित माध्यम से उजागर करता है:

• संग्रहीत रिपोर्ट्स के मेटाडेटा को प्राप्त करने के लिए एक REST API
• रिपोर्ट आर्टिफैक्ट्स को ZIP अभिलेखों के रूप में डाउनलोड करने के लिए एक एंडपॉइंट

इन क्षमताओं से CI/CD पाइपलाइन, GRC सिस्टम, आंतरिक डैशबोर्ड, और तृतीय‑पक्ष जोखिम प्रबंधन टूल्स के साथ एकीकरण संभव हो जाता है।

प्रमाणीकरण और प्राधिकरण

इस लेख में वर्णित सभी API अनुरोधों के लिए प्रमाणीकरण आवश्यक नहीं है।

संगठन आईडी

सभी अनुरोधों के लिए एक संगठन आईडी आवश्यक है। आप इसे संगठन के सेटिंग्स पैनल में https://dashboard.procurize.ai पर पा सकते हैं। कृपया ध्यान दें कि सेटिंग्स पैनल तक पहुँच के लिए प्राधिकरण आवश्यक है, और संगठन के सेटिंग्स पैनल तक पहुँचने के लिए आपके पास उस संगठन में कम से कम प्रशासक भूमिका होनी चाहिए।

बेस URL

सभी REST API एंडपॉइंट्स निम्नलिखित बेस URL के तहत उपलब्ध हैं:

https://api.procurize.com

SonarQube रिपोर्ट्स REST API

रिपोर्ट्स की सूची

प्लेटफ़ॉर्म में संग्रहीत SonarQube सुरक्षा रिपोर्ट्स की पेजिनेटेड सूची प्राप्त करता है।

एंडपॉइंट

GET /security/report/list

क्वेरी पैरामीटर

• org (आवश्यक): संगठन आईडी।
• version (वैकल्पिक): उत्पादों का सटीक संस्करण, सिमेंटिक वर्ज़निंग फ़ॉर्मेट में।
• minver (वैकल्पिक): उत्पादों का न्यूनतम संस्करण, सिमेंटिक वर्ज़निंग फ़ॉर्मेट में।
• maxver (वैकल्पिक): उत्पादों का अधिकतम संस्करण, सिमेंटिक वर्ज़निंग फ़ॉर्मेट में।

कृपया ध्यान दें कि अनुरोध में version, minver या maxver में से कम से कम एक पैरामीटर आवश्यक है।

अनुरोध उदाहरण

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

प्रतिक्रिया उदाहरण

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

रिपोर्ट अभिलेख डाउनलोड करें

पूरा SonarQube रिपोर्ट आर्टिफैक्ट्स (HTML और PDF रिपोर्ट सहित) वाले ZIP अभिलेख को डाउनलोड करता है।

एंडपॉइंट

GET /security/report/files

• org (आवश्यक): संगठन आईडी।
• reports (आवश्यक): रिपोर्ट आईडी की एरे।

अनुरोध उदाहरण

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"

प्रतिक्रिया

• Content-Type: application/zip
• प्रतिक्रिया बॉडी में बाइनरी ZIP फ़ाइल होती है

क्लाइंट को प्रतिक्रिया को स्ट्रीम करके डिस्क पर सहेजना चाहिए।

त्रुटि हैंडलिंग

API मानक HTTP स्थिति कोड का उपयोग करती है।

• 200 OK: अनुरोध सफल
• 204 No Content: रिपोर्ट मौजूद नहीं है
• 400 Bad Request: अमान्य पैरामीटर या खराब अनुरोध
• 500 Internal Server Error: अप्रत्याशित सर्वर त्रुटि

त्रुटि प्रतिक्रियाओं में मशीन‑पठनीय त्रुटि कोड और मानव‑पठनीय संदेश शामिल होते हैं।

संबंधित देखिए:

• SonarQube रिपोर्ट्स वेबहुक्स

संबंधित लेख

• सुरक्षा रिपोर्ट्स क्या हैं?
• सुरक्षा रिपोर्ट्स रिपॉज़िटरी
• सुरक्षा रिपोर्ट्स को कॉन्फ़िगर कैसे करें