認証
すべての API リクエストでは、ワークスペースで作成した Bearer トークンを使用します。
Vergora では、API リクエストの認証に API キーを使用します。リクエストはサーバー側のアプリケーションから送信し、認証情報は
Authorizationヘッダーで渡してください。
リクエストヘッダー
Authorization: Bearer YOUR_VERGORA_API_KEYBearer と API キーの間には半角スペースを 1 つ入れてください。API キーを URL のクエリパラメーターに含めないでください。
API キーを作成する
- コンソールにログインし、API キー を開きます。
- 新しい API キーを作成します。
storefront-productionのように、アプリケーションと環境がわかる名前を付けます。- アプリケーションに合わせて、予算、有効期限、モデルへのアクセスを設定します。
- ページの案内に従って、API キー全体をコピーし、安全な場所に保存します。
設定のガイドライン
| 設定 | ガイドライン |
|---|---|
| 名前 | アプリケーションと環境を含めます |
| 環境 | 開発、テスト、本番で別々のキーを使用します |
| 予算 | 想定される使用量に合わせて設定します。キーの予算を設定しても、ウォレットに残高が追加されるわけではありません |
| 有効期限 | 一時的なテストには短い期間を設定し、本番用のキーは定期的に見直します |
| モデルへのアクセス | アプリケーションに必要なモデルのみを許可します |
| 送信元の制限 | 有効にする場合は、アプリケーションの実際の送信元アドレスを指定します |
アプリケーションでキーを使用する
export VERGORA_API_KEY="YOUR_VERGORA_API_KEY"値は、サーバー側の環境変数またはシークレットマネージャーから読み込みます。キー全体を、ソースコード、ブラウザーのスクリプト、公開リポジトリ、ログ、スクリーンショットで公開しないでください。
キーのローテーションと使用停止
- 代わりとなる新しいキーを作成します。
- アプリケーションを更新し、最小限のリクエストを送信します。
- リクエストログで新しいリクエストを確認します。
- 古いキーの使用を停止します。
- 古い認証情報を使用しているアプリケーションが残っていないことを確認します。
キー全体を紛失した場合は、コンソールに用意されている手順に従って代わりのキーを作成してください。漏えいの疑いがある場合は、該当する認証情報の使用を直ちに停止し、関連するリクエストログを確認してください。
認証のトラブルシューティング
| 確認項目 | 推奨される対応 |
|---|---|
| API キーが空または不完全 | サーバー側の環境変数を再読み込みします |
| リクエストヘッダーが無効 | Authorization: Bearer <key> を使用します |
| キーの有効期限が切れている、または無効になっている | ステータスを確認し、代わりのキーを作成します |
| 予算またはモデルの範囲によってリクエストがブロックされている | キーのポリシーと選択したモデルを確認します |
| リクエストの送信元が許可されていない | アプリケーションの実際の送信元アドレスを確認します |
初めて連携する場合は、先にクイックスタートを完了してください。