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

​
APIキー認証

すべてのOpen APIリクエストには、Bearerトークン形式のAPIキーが必要です。 
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日、無期限

​
キーの失効

使用しなくなったキーは直ちに失効させてください：
  1. Open APIページでキー一覧を確認
  2. 該当キーの 失効 ボタンをクリック
  3. 確認モーダルで 失効 を選択
APIキーは失効完了直後にすべての使用が停止されるため、失効前に該当キーと連携しているアプリケーションがないか確認し、新しいキーを発行・適用してください。

​
キータイプ

APIキーは用途に応じて2種類で発行され、アクセス可能なエンドポイントが分離されます。
タイププレフィックス用途アクセス可能遮断
Client SDKosk_iOS/Android、Webなどのクライアントpersona, chat/, events, datachat/completions
REST APIosr_サーバー間連携chat/completionspersona, chat/, events, data
GET /v1/models は共通エンドポイントで、キータイプによって返されるモデルが異なります。 テナントのOpen APIページでの発行時に、タブでタイプを選択します。
誤ったキータイプでエンドポイントにアクセスすると 403 Forbidden が返されます。

​
スコープ (Scopes)

キータイプによって割り当てられるスコープが異なります。

​
Client SDK (osk_)

スコープアクセス可能なエンドポイント
persona/v1/persona/**
chat/v1/chat/{persona_id}/**
data_ingest/v1/data/events

​
REST API (osr_)

スコープアクセス可能なエンドポイント
chat/v1/chat/completions
analytics/v1/usage

​
共通

エンドポイント説明
/v1/modelsキータイプに応じた利用可能モデルを返却

​
エラーレスポンス

HTTPコード原因
401APIキー未指定、無効なキー、期限切れキー
403Open API無効化テナント、スコープ不足
{
  "success": false,
  "message": "Invalid or expired API key"
}

​
セキュリティ推奨事項

  • APIキーをソースコードに直接含めないでください
  • 環境変数またはシークレットマネージャを使用してください
  • iOSアプリの場合はKeychainに保存してください
  • サーバー側では環境変数で管理してください
  • 不要なキーは直ちに失効させてください