SonarQube レポート API

このドキュメントは、Procurize プラットフォームに保存されている SonarQube のセキュリティレポートへプログラムからアクセスする方法を説明します。レポートの一覧取得、取得、ZIP アーカイブのダウンロードに関する REST API をカバーしています。

概要

SonarQube レポートサブモジュールは、組織が SonarQube が生成したセキュリティおよびコード品質レポートを集中管理・保存できるようにします。Procurize プラットフォームはこのデータを以下の形で公開しています。

  • 保存されたレポートのメタデータを取得する REST API
  • レポート成果物(ZIP アーカイブ)をダウンロードするエンドポイント

これらの機能により、CI/CD パイプライン、GRC システム、内部ダッシュボード、サードパーティのリスク管理ツールとの統合が可能になります。

認証と認可

本記事で説明するすべての API リクエストは認証不要です。

組織 ID

すべてのリクエストで組織 ID が必要です。
組織 ID は https://dashboard.procurize.ai設定パネル で確認できます。
設定パネルへのアクセスには権限が必要で、組織の設定パネルにアクセスできるのは少なくとも Administrator ロールを持つユーザーです。

ID コピー ボタン

ベース URL

すべての REST API エンドポイントは次のベース URL 配下で提供されます。

https://api.procurize.com

SonarQube レポート REST API

レポート一覧取得

プラットフォームに保存されている SonarQube セキュリティレポートのページングされた一覧を取得します。

エンドポイント

GET /security/report/list

クエリパラメータ

  • org (必須): 組織 ID
  • version (任意): セマンティックバージョニング形式の正確なバージョン
  • minver (任意): セマンティックバージョニング形式の最低バージョン
  • maxver (任意): セマンティックバージョニング形式の最大バージョン

versionminvermaxver のうち少なくとも1つは指定する必要があります。

リクエスト例

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 (必須): 組織 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: 予期しないサーバーエラー

エラーレスポンスには機械可読なエラーコードと人間可読なメッセージが含まれます。

参照情報

関連記事

セキュリティレポートとは?

セキュリティレポートリポジトリ

セキュリティレポートの設定方法

トップへ
言語を選択