​

Corgea APIへようこそ

​

Corgea APIで何ができる?

​

API機能

​

認証と認可

• トークン検証:APIトークンの検証とユーザー情報の取得
• 認可フロー:APIトークンと認証コードを交換

​

APIのスキャン

• スキャン開始:大規模なコードベースに対してチャンクファイルアップロードで新たなBLASTスキャンを開始する
• スキャン結果のアップロード:外部セキュリティツールからスキャンレポートを送信
• スキャンの取得:フィルタリングとページネーションでスキャン履歴を取得
• スキャンの詳細取得:特定のスキャンに関する詳細情報へのアクセス
• スキャンレポート:スキャン用のHTML、SARIF、またはMarkdownレポートを生成

​

問題管理API

• 問題の取得:フィルタリングオプションを含むすべてのセキュリティ問題を一覧化
• 問題の詳細取得: 特定の脆弱性に関する包括的な情報を取得する
• SCAの問題:ソフトウェア構成分析(SCA)脆弱性
• 問題のフィルタリング:プロジェクト、リポジトリ、緊急性などでフィルタリング

​

ポリシー管理

• ブロッキングルール:セキュリティポリシーの定義と管理
• ルール検証:スキャンがブロッキングルールに違反しているかどうかをチェック
• ポリシーの適用:セキュリティポリシーに基づくデプロイメントを防止する

​

基本URL

https://www.corgea.app/api/v1

https://<your-instance>.corgea.app/api/v1

​

認証

CORGEA-TOKEN: your_api_token_here

​

認証の始め方

1. APIトークンを取得する:Corgeaアカウントの設定からAPIトークンを取得してください
2. トークンの検証: /verify エンドポイントを使ってトークンの有効性を確認します
3. オプションのユーザー情報:ユーザーおよび企業情報を得るための ?user_info=true を含める

​

認証方法

curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify

curl https://www.corgea.app/api/v1/verify/your_token_here

​

認可フロー

1. ユーザーをCorgeaの認証ページにリダイレクトします
2. ユーザーがアプリケーションを承認し、認証コードを受け取る
3. コードをAPIトークンと交換する /authorize?code=your_code

​

レスポンス形式

{
  "status": "ok",
  "data": { }
}

{
  "status": "error",
  "message": "Description of the error"
}

​

HTTPステータスコード

​

ページネーション

• page:ページ番号(デフォルト:1)
• page_size:ページあたりの結果数(デフォルト:20、最大:50)

{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}

​

お困りの場合は

​

クイックスタート

1. Corgeaアカウントの設定からAPIトークンを取得します
2. ヘッダー認証を使って/verifyエンドポイントでトークンを検証します
3. 実際にAPIを実行して、スキャンレポートをアップロードするか、セキュリティ問題を一覧表示してみてください