Getting Started - OneSight

APIキー認証

すべてのOpen APIリクエストには、Bearerトークン形式のAPIキーが必要です。

Authorization: Bearer osk_megamart_a1b2c3d4e5f6g7h8...

APIキーは発行時に一度だけ表示されます。後から再確認することはできないため、必ず安全な場所に保管してください。

7日、14日、30日、60日、90日、180日、365日、無期限

使用しなくなったキーは直ちに失効させてください：

APIキーは失効完了直後にすべての使用が停止されるため、失効前に該当キーと連携しているアプリケーションがないか確認し、新しいキーを発行・適用してください。

タイプ	プレフィックス	用途	アクセス可能
Client SDK	`osk_`	iOS/Android、Webなどのクライアント	profile, chat/

スコープ	アクセス可能なエンドポイント
`profile`	`/v1/profile/**`
`chat`	`/v1/chat/{profile_id}/**`

HTTPコード	原因
401	APIキー未指定、無効なキー、期限切れキー
403	Open API無効化テナント、スコープ不足

{
  "success": false,
  "message": "Invalid or expired API key"
}