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

# APIキー

> AgentWallex統合用のAPIキーの作成、管理、ローテーション。

## 概要

APIキーは、サーバーサイドアプリケーションをAgentWallex APIで認証します。各キーは`awx_`プレフィックスで始まり、アカウントに紐付けられています。

## APIキーの作成

ダッシュボードまたはREST API（JWT認証が必要）を通じてAPIキーを作成します：

### ダッシュボード経由

1. [AgentWallexダッシュボード](https://app.agentwallex.com)にログインします。
2. **Settings > API Keys** に移動します。
3. **Create API Key** をクリックします。
4. キーにわかりやすい名前を付けます（例：`production-backend`、`staging-ci`）。
5. キーをコピーして安全に保管します — 一度しか表示されません。

### API経由

```bash theme={null}
curl -X POST https://api.agentwallex.com/api/v1/api-keys \
  -H "Authorization: Bearer eyJhbGciOi..." \
  -H "Content-Type: application/json" \
  -d '{"name": "production-backend"}'
```

<Warning>
  完全なAPIキーは作成時に一度だけ返されます。すぐに安全なシークレットマネージャーに保存してください。
</Warning>

## APIキーの一覧表示

```bash theme={null}
curl -X GET https://api.agentwallex.com/api/v1/api-keys \
  -H "Authorization: Bearer eyJhbGciOi..."
```

レスポンスにはキーのメタデータが含まれますが、完全なキー値は含まれません：

```json theme={null}
{
  "data": [
    {
      "id": "key_abc123",
      "name": "production-backend",
      "prefix": "awx_...x4f2",
      "created_at": "2025-06-01T10:00:00Z",
      "last_used_at": "2025-06-15T14:30:00Z"
    }
  ]
}
```

## APIキーのローテーション

<Steps>
  <Step title="新しいキーの作成">
    ダッシュボードまたはAPIで新しいAPIキーを作成します。
  </Step>

  <Step title="アプリケーションの更新">
    新しいキーをアプリケーションの環境変数にデプロイします。
  </Step>

  <Step title="新しいキーの動作確認">
    新しいキーでAPI呼び出しが成功することを確認します。
  </Step>

  <Step title="古いキーの削除">
    不正アクセスを防ぐために古いキーを削除します：

    ```bash theme={null}
    curl -X DELETE https://api.agentwallex.com/api/v1/api-keys/key_abc123 \
      -H "Authorization: Bearer eyJhbGciOi..."
    ```
  </Step>
</Steps>

<Tip>
  少なくとも90日ごとにAPIキーをローテーションしてください。カレンダーリマインダーを設定するか、CI/CDパイプラインでローテーションを自動化してください。
</Tip>

## レート制限

APIレート制限はプランティアに依存します：

| プラン        | リクエスト/分 | リクエスト/日 | 同時接続 |
| ---------- | ------- | ------- | ---- |
| Starter    | 60      | 10,000  | 5    |
| Growth     | 300     | 100,000 | 25   |
| Enterprise | カスタム    | カスタム    | カスタム |

レート制限を超過すると、APIは`Retry-After`ヘッダー付きの`429 Too Many Requests`レスポンスを返します：

```json theme={null}
{
  "code": "rate_limit_exceeded",
  "type": "rate_limit_error",
  "message": "Rate limit exceeded. Retry after 30 seconds."
}
```

<Note>
  レート制限はAPIキーごとに適用されます。より高い制限が必要な場合は、AgentWallexチームにお問い合わせいただくか、プランをアップグレードしてください。
</Note>

## ベストプラクティス

* **環境ごとに1つのキー** — 開発、ステージング、本番で別々のキーを使用してください。
* **キーにわかりやすい名前を付ける** — 環境とサービス名を含めてください（例：`prod-payment-service`）。
* **使用状況を監視する** — `last_used_at`を確認して、削除すべき未使用のキーを特定してください。
* **キーを共有しない** — 各チームメンバーやサービスには独自のキーを用意してください。
* **シークレットマネージャーを使用する** — ディスク上の`.env`ファイルではなく、AWS Secrets Manager、HashiCorp Vault、または同様のツールにキーを保存してください。