SonarQube 보고서 API

이 문서는 Procurize 플랫폼에 저장된 SonarQube 보안 보고서에 프로그래밍 방식으로 접근하는 방법을 설명합니다. 보고서 목록 조회와 검색 및 보고서 아카이브 다운로드를 위한 REST API를 다룹니다.

개요

SonarQube 보고서 서브모듈을 통해 조직은 SonarQube에서 생성된 보안 및 코드 품질 보고서를 중앙에서 저장하고 관리할 수 있습니다. Procurize 플랫폼은 다음을 통해 이 데이터를 제공합니다:

저장된 보고서 메타데이터를 조회하는 REST API
보고서 아티팩트를 ZIP 아카이브로 다운로드하는 엔드포인트

이 기능을 통해 CI/CD 파이프라인, GRC 시스템, 내부 대시보드 및 타사 위험 관리 도구와 통합할 수 있습니다.

인증 및 권한 부여

이 문서에서 설명하는 모든 API 요청은 인증이 필요하지 않습니다.

조직 ID

여기서 설명하는 모든 요청에는 조직 ID가 필요합니다. 조직 ID는 https://dashboard.procurize.ai 에서 조직의 설정 패널에서 찾을 수 있습니다. 설정 패널에 접근하려면 권한이 필요하며, 조직의 설정 패널에 접근하려면 해당 조직에서 최소 관리자 역할 이상의 사용자 역할이 필요합니다.

ID 복사 버튼

기본 URL

모든 REST API 엔드포인트는 다음 기본 URL에서 제공됩니다:

https://api.procurize.com

SonarQube 보고서 REST API

보고서 목록

플랫폼에 저장된 SonarQube 보안 보고서의 페이지네이션된 목록을 가져옵니다.

엔드포인트

GET /security/report/list

쿼리 매개변수

org (필수): 조직 ID.
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"
    }
  ]
}

보고서 아카이브 다운로드

전체 SonarQube 보고서 아티팩트를 포함하는 ZIP 아카이브를 다운로드합니다. 아카이브에는 HTML 및 PDF 보고서가 포함됩니다.

엔드포인트

GET /security/report/files

org (필수): 조직 ID.
reports (필수): 보고서 ID 배열.

요청 예시

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 보고서 웹훅