API รายงาน SonarQube

บทความนี้อธิบายวิธีเข้าถึงรายงานความปลอดภัยของ SonarQube ที่จัดเก็บไว้ในแพลตฟอร์ม Procurize แบบโปรแกรม ครอบคลุม REST API สำหรับแสดงรายการและดึงรายงานและการดาวน์โหลดไฟล์เก็บรายงาน

ภาพรวม

โมดูลย่อย SonarQube Reports ช่วยให้องค์กรจัดเก็บและจัดการรายงานความปลอดภัยและคุณภาพโค้ดที่สร้างโดย SonarQube อย่างศูนย์กลาง แพลตฟอร์ม Procurize เปิดเผยข้อมูลนี้ผ่าน:

REST API สำหรับดึงข้อมูลเมตาของรายงานที่จัดเก็บ
จุดเชื่อมต่อสำหรับดาวน์โหลดไฟล์ศิลปะรายงานเป็นไฟล์ ZIP

ความสามารถเหล่านี้ทำให้สามารถผสานรวมกับสายงาน CI/CD ระบบ GRC แดชบอร์ดภายในและเครื่องมือจัดการความเสี่ยงของบุคคลที่สาม

การตรวจสอบตัวตนและการอนุญาต

คำขอ API ทั้งหมดที่อธิบายในบทความนี้ไม่ต้องการการยืนยันตัวตน

รหัสองค์กร

ต้องระบุรหัสองค์กรสำหรับคำขอทั้งหมดที่อธิบายไว้ที่นี่ คุณสามารถค้นหาได้ใน แผงการตั้งค่าองค์กร ที่ https://dashboard.procurize.ai โปรดทราบว่าการเข้าถึงแผงการตั้งค่าต้องได้รับการอนุญาต และการเข้าถึงแผงการตั้งค่าองค์กรต้องมีบทบาทผู้ใช้อย่างน้อยเป็นผู้ดูแลระบบในองค์กรนั้น

ปุ่มคัดลอกรหัส

URL พื้นฐาน

ทุกจุดเชื่อมต่อ REST API ให้บริการภายใต้ URL พื้นฐานต่อไปนี้:

https://api.procurize.com

SonarQube Reports REST API

แสดงรายการรายงาน

ดึงรายการรายงานความปลอดภัยของ SonarQube ที่จัดเก็บในแพลตฟอร์มโดยเป็นแบบแบ่งหน้า

จุดเชื่อมต่อ

GET /security/report/list

พารามิเตอร์การค้นหา

org (จำเป็น): รหัสองค์กร.
version (ไม่บังคับ): รุ่นที่แน่นอนของผลิตภัณฑ์ในรูปแบบ Semantic Versioning.
minver (ไม่บังคับ): รุ่นต่ำสุดของผลิตภัณฑ์ในรูปแบบ Semantic Versioning.
maxver (ไม่บังคับ): รุ่นสูงสุดของผลิตภัณฑ์ในรูปแบบ Semantic Versioning.

โปรดทราบว่าต้องระบุอย่างน้อยหนึ่งในพารามิเตอร์ 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"
    }
  ]
}

ดาวน์โหลดไฟล์เก็บรายงาน

ดาวน์โหลดไฟล์ ZIP ที่บรรจุศิลปะรายงาน SonarQube เต็มชุด ไฟล์เก็บรวมถึงรายงานในรูปแบบ HTML และ PDF

จุดเชื่อมต่อ

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: ข้อผิดพลาดเซิร์ฟเวอร์ที่ไม่คาดคิด

การตอบกลับข้อผิดพลาดจะรวมรหัสข้อผิดพลาดที่อ่านได้โดยเครื่องและข้อความที่อ่านได้โดยมนุษย์