> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corgea.app/llms.txt
> Use this file to discover all available pages before exploring further.

# APIリファレンス

> Corgea APIの利用を開始する

# Corgea APIへようこそ

Corgea APIを使用すると、Corgeaのアプリケーションセキュリティプラットフォームとプログラムで連携できます。脆弱性スキャンの自動化、セキュリティ問題の取得、修正の管理、Corgeaの開発ワークフローとの連携が可能です。

## Corgea APIで何ができる?

<CardGroup cols={2}>
  <Card title="スキャン管理" icon="radar">
    セキュリティスキャンを開始し、スキャン結果をアップロードし、スキャンの進捗を監視します
  </Card>

  <Card title="問題管理" icon="bug">
    脆弱性の詳細取得、問題のステータスの管理、修復の追跡
  </Card>

  <Card title="自動修正取得" icon="wand-magic-sparkles">
    AI生成のセキュリティ修正や特定された脆弱性パッチへのアクセス
  </Card>

  <Card title="CI/CD 統合" icon="code-branch">
    セキュリティスキャンを継続的インテグレーションのパイプラインに統合できます
  </Card>
</CardGroup>

## API機能

### 認証と認可

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

### APIのスキャン

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

### 問題管理API

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

### ポリシー管理

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

## 基本URL

すべてのAPIリクエストは以下のいずれかに行うべきです:

私たちのマルチテナント環境

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

あるいは単一テナント環境

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

## 認証

Corgea APIはAPIキー認証を使用しています。リクエストヘッダーにAPIトークンを含めてください:

```bash theme={null}
CORGEA-TOKEN: your_api_token_here
```

### 認証の始め方

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

### 認証方法

**ヘッダーベースの認証** (推奨):

```bash theme={null}
curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify
```

**パスベースの認証** (廃止):

```bash theme={null}
curl https://www.corgea.app/api/v1/verify/your_token_here
```

### 認可フロー

ユーザー認証が必要なアプリケーション:

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

<Note>
  一部のエンドポイント( `/verify/{token}` や `/authorize`など)は認証を必要としません。具体的な要件については、エンドポイントごとのドキュメントを確認してください。
</Note>

## レスポンス形式

すべてのAPIレスポンスはJSON形式で返されます。成功したレスポンスには `status` フィールドが含まれます:

```json theme={null}
{
  "status": "ok",
  "data": { }
}
```

エラーレスポンスには説明的なメッセージが含まれます:

```json theme={null}
{
  "status": "error",
  "message": "Description of the error"
}
```

## HTTPステータスコード

APIは標準的なHTTPステータスコードを使用します:

| コード   | 説明                                |
| ----- | --------------------------------- |
| `200` | リクエスト成功                           |
| `400` | Bad Request - パラメータまたはリクエストボディが無効 |
| `401` | 不正 - 認証が無効または欠如                   |
| `404` | リソースが見つかりません                      |
| `429` | レート上限を超えた                         |
| `500` | 内部サーバーエラー                         |

## ページネーション

リストを返すエンドポイントはクエリパラメータを用いたページネーションをサポートしています:

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

ページ付きレスポンスには以下が含まれます:

```json theme={null}
{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}
```

## お困りの場合は

<CardGroup cols={2}>
  <Card title="認証ガイド" icon="key" href="/ja/api-reference/authentication">
    APIリクエストの認証方法を確認できます
  </Card>

  <Card title="支援" icon="life-ring" href="https://corgea-community.slack.com/join/shared_invite/zt-2cjmxat2f-Znvd06nP2gn9RYOSWrZI2A#">
    サポートチームまでご連絡ください
  </Card>
</CardGroup>

## クイックスタート

Corgea APIの使い始めは3つのステップで行います:

1. **Corgeaアカウントの設定からAPIトークンを取得します**
2. **ヘッダー認証を使って`/verify`エンドポイントでトークンを検証します**
3. **実際にAPIを実行して、[スキャンレポートをアップロード](https://docs.corgea.app/api-reference/uploading-3rd-party-scan/upload-scan)するか、[セキュリティ問題を一覧表示](https://docs.corgea.app/api-reference/issues/list-all-issues)してみてください**

サイドバーのAPIエンドポイントを詳しくご覧ください。