プログラムによる API Key 管理
アクセストークンを使用して API Key を照会、作成、更新、削除します。
アプリで API Key 管理を自動化するためのガイドです。モデル呼び出しや SDK 設定のみの場合は API Key と認証をご覧ください。
アクセストークンを取得
プロフィールの「セキュリティ」でアクセストークンを作成し、そのユーザーの API Key を管理します。
アクセストークンとモデル API Key は用途が異なります。管理 API はアクセストークン、モデル API は API Keyを使用し、混用しないでください。
最初の管理リクエスト
your-user-token をアクセストークンに置き換え、API Key 一覧を取得します：
curl 'https://api.agtcloud.cn/api/token/?p=1&size=20' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your-user-token'成功後、data.items から対象 Key を見つけ、詳細取得・更新・削除に使う id を保存します。記録がなければ items は空配列です。
一覧・詳細の key はマスクされ、モデル呼び出しには使用できない場合があります。完全な秘密鍵は API Keys ページで確認してください。
管理操作を選択
各 Reference でパラメーター、応答例を確認するか、オンラインテストを利用してください。
| 操作 | 用途 |
|---|---|
| API Key 一覧を取得 | API Key をページ表示 |
| API Key を検索 | 名前またはキー値で検索 |
| API Key の詳細を取得 | ID で詳細設定を取得 |
| API Key を作成 | 名前・クォータ・期限・アクセス制限を設定 |
| API Key を更新 | 設定変更または有効化・無効化 |
| API Key を削除 | 指定 Key を削除 |
| API Key を一括削除 | 複数 Key を削除 |
Key 自身の残量は API Key のクォータを照会で確認します。アクセストークンではなく、その Key で認証してください。
操作時の注意
更新・削除前に対象を確認
通常更新は省略項目をリセットする場合があります。先に詳細を読み、保持する設定をすべて送信してください。有効化・無効化だけなら「状態のみ更新」を使います。
削除はその Key を利用するアプリに影響します。対象 ID を確認し、例の ID で削除しないでください。
- 業務結果を確認：HTTP
200でも業務失敗の場合があります。successとmessageも確認してください。 - 重複書き込みを回避：作成・更新・削除がタイムアウトした場合、先に取得して反映を確認し、直ちに再送しないでください。
- アクセストークンを保護：管理されたサーバーに保存し、フロントエンド、公開ログ、画像、リポジトリに含めないでください。キー値を含む検索 URL も保護してください。