メインコンテンツへスキップ

APIキー認証

すべてのOpen APIリクエストにはBearerトークンが必要です:
Authorization: Bearer osk_megamart_a1b2c3d4e5f6g7h8...

APIキーの発行

前提条件

  • テナント管理者(admin)権限が必要
  • 管理画面で該当テナントのOpen APIが有効化されている必要あり

発行手順

  1. テナントページに管理者でログイン
  2. プロフィールメニューからOpen APIをクリック
  3. 新規APIキー発行ボタンをクリック
  4. キー名と有効期限を選択
  5. 発行されたキーを安全な場所にコピー
APIキーは発行時に一度だけ表示されます。後から確認できませんので、必ず安全な場所に保管してください。

有効期限オプション

オプション用途
7日テスト・開発用
14日短期プロジェクト
30日デフォルト
60日 / 90日中期運用
180日 / 365日長期運用
無期限期限なし

キー形式

osk_{tenant_code}_{random_hex_64}

キー管理

キーの廃棄

不要なキーは直ちに廃棄してください。
廃棄されたキーは直ちに使用不可となり、復元できません。

キーの状態

状態説明
有効正常に使用可能
期限切れ有効期限を過ぎた(自動)
廃棄済み手動で廃棄された

スコープ

スコープアクセス可能なエンドポイント
chat/chat/completions, /models
data_ingest/data/events
analytics/usage
デフォルトですべてのスコープが有効です。

セキュリティのベストプラクティス

  • APIキーをソースコードに含めない
  • 環境変数やシークレットマネージャーを使用する
  • iOSアプリの場合はKeychainに保存する
  • 不要なキーは速やかに廃棄する