認証とキー
認証方法
すべてのインターフェースは Bearer Token 認証を使用します。リクエストヘッダーに API トークンを含めてください:
Authorization: Bearer sk-xxxxxxxxxxxxxxxxトークンは管理画面の トークン(API Keys) ページで作成および管理します。
トークンの機能
トークン作成時に必要に応じて設定できます:
| 設定項目 | 説明 |
|---|---|
| 名前 | 用途を区別しやすくするため(例: prod-app、test) |
| 上限額 | そのトークンが消費できる最大額。超過するとリクエストは拒否される |
| 有効期限 | 期限到来時に自動で無効化。一時的な認可に適している |
| モデルグループ | トークンが呼び出せるモデルの範囲を制限する |
| IP ホワイトリスト | 許可された送信元 IP を制限する(任意) |
1つのアカウントで複数のトークンを作成できます。環境/プロジェクトごとに分割することを推奨します。これにより、使用量の集計と回収が容易になります。
セキュリティに関する推奨事項
- キーはサーバー側の環境変数または秘密管理サービスにのみ保存し、絶対に フロントエンドコードや公開リポジトリに書き込まないでください;
- 異なるプロジェクトには異なるトークンを使用し、漏えいした場合は個別のトークンだけを失効できます;
- テスト用トークンには、より小さい上限額と有効期限を設定してください;
- 異常な使用量を検知したら、まず管理画面でトークンを無効化してから、呼び出し元を調査してください。
よくある認証エラー
| HTTP ステータス | 意味 | 対処 |
|---|---|---|
| 401 | キーが欠落しているか無効 | Authorization ヘッダーとキーが完全か確認する |
| 403 | トークンが無効化されている / グループにそのモデルへのアクセス権がない | トークンの状態とモデルグループを確認する |
| 429 | レート制限に達した、または残高不足 | レート制限と 429 を参照 |