API キー
コードが認証に使うキーを作成し、権限を絞り、ローテーションします。ゲートウェイが必要とする資格情報はキーだけです。すべてのモデル、すべてのエンドポイントで同じキーを使います。
コンソールのサイドバー(その機能がアカウントに適用されると表示されます): API keys 開く ↗
手順
- API keys を開き、Create key を押します。
- 半年後でも判別できる名前を付けます。ローテーション時にキーを見分ける手がかりは名前です。
- 持たせる制限を設定します:リセット間隔付きの利用額クォータ、許可するモデルの一覧、IP 許可リスト、有効期限。いずれも任意です。何も設定しないキーは、ワークスペースがアクセスできるすべてのモデルを呼び出せます。
- キーはすぐにコピーしてシークレットストアに保管します。送信時は
Authorization: Bearer <key>として渡します。
制限と注意点
- キーは一度だけ表示されます。再表示する方法はありません。紛失した場合は削除して作り直してください。
- キーの削除は即時に有効になります。ローテーションは、新しいキーを作成し、デプロイし、その後で古いキーを削除する、という順序で行ってください。
- キーはワークスペースに属します。ワークスペースを切り替えると表示されるキーも変わり、キーが別のワークスペースに及ぶことはありません。
- IP 許可リストは、キーに設定しておく固定のリストです。新しいアドレスが現れるたびに承認する運用にしたい場合は、ワークスペースで信頼済み IPをオンにしてください。許可リストを持つキーは、引き続きそのリストだけで判断されます。
同じ機能の API リファレンス: API キー