認証
Webway の API キーを安全に作成・送信・ローテーション・失効する方法。
キーは API キーで作成します。sk-ww- で始まり、個人ではなく組織に
属するため、メンバーの入れ替わりがあっても有効なままです。
ヘッダー
プロトコルごとに必要なヘッダーを使ってください。
| プロトコル | 認証 |
|---|---|
| Chat completions、Responses、Images | Authorization: Bearer sk-ww-… |
| Claude Messages | x-api-key: sk-ww-… |
| Gemini ネイティブのクライアント | x-goog-api-key: sk-ww-… |
Claude Messages のリクエストには anthropic-version: 2023-06-01 も必要です。
キーを安全に保管する
キー本体が表示されるのは一度だけです。Webway は SHA-256 ハッシュを保存するため、 失くしたキーを復元することはできません。
- キーは環境変数かシークレットマネージャーに入れてください。
- キーをコミットしたり、ブラウザやモバイルのコードに含めたりしないでください。
- 環境やサービスごとにキーを分けると、使用量の出どころがはっきりします。
キーが漏れた場合は直ちに失効させてください。失効は次のリクエストから適用されます。
停止せずにローテーションする
- 置き換え用のキーを作成します。
- 置き換え用のキーをデプロイします。
- 古いキーの 最終使用 が更新されなくなったことを確認します。
- 古いキーを失効させます。
キーが存在しない、期限切れ、失効済み、不正のいずれの場合も 401 を返します。
レスポンスの形式はエラーを参照してください。