第 2 章 / 全 21 章約 3 分

2. API キーの作成と管理#

API キーは、すべてのエンドポイントを呼び出すための唯一の認証情報です。

API キーの取得(コンソールでの操作手順)#

  1. YiTuoToken コンソールにログインします。
  2. 左側のナビゲーションで「API キー」をクリックし、キー管理ページを開きます。
  3. 「API キーを作成」ボタンをクリックします。
  4. 開いたダイアログで以下を入力します:
    • キー名(必須。例:「本番環境サービス」。用途の区別に使用)
    • クォータ上限(任意。空欄の場合は無制限)
    • IP ホワイトリスト(任意。呼び出し可能な送信元 IP / CIDR を制限)
    • 有効期限(任意。期限切れ後は自動的に無効化)
    • 利用可能モデルのホワイトリスト(任意。このキーが呼び出せるモデルの範囲を限定)
  5. 「キーを作成」をクリックして送信します。
  6. 「新しいキーを保存」ダイアログが表示されます — 完全なキーの平文はこのとき 1 回だけ表示されます。「キーをコピー」をクリックして安全な場所に保存し、「保存しました」をクリックして閉じます。

ダイアログを閉じると、完全なキーを二度と表示できません。システムはキーのハッシュのみを保存し、平文はデータベースに保存されません。保存し損ねた場合は、そのキーを失効させて新しく作成してください。

設定項目#

設定説明
名前用途の区別に役立ちます(例:「本番環境」「ローカルテスト」)
クォータ上限このキーが消費できるクォータの上限。使い切るとリクエストは 402 を返します
IP ホワイトリスト送信元 IP を制限します。単一 IP と CIDR 範囲に対応(カンマ区切り)
有効期限期限切れ後、キーは自動的に無効になります
モデルホワイトリストこのキーが呼び出せるモデルの範囲を限定します

管理操作#

  • 失効: キーが漏洩した場合や使用しなくなった場合は直ちに失効させてください。失効後、そのキーでのすべてのリクエストは 401 を返します。
  • ローテーション: 定期的に新しいキーを作成して古いキーを順次置き換えることをお勧めします。漏洩リスクを低減できます。

セキュリティ上の注意: API キーをフロントエンドのコード、公開リポジトリ、クライアントアプリにハードコードしないでください。環境変数またはバックエンドサービスで保持してください。