Skip to main content

認証情報の取得

HappyOyster のサーバーとクライアントに必要な認証情報（API Host、プライマリ API キー、一時 API キー、ticket）を取得します。

HappyOyster の全体的なアーキテクチャについては、概要を参照してください。

認証情報

すべての API は Alibaba Cloud Model Studio ゲートウェイを介して認証されます。使用する認証情報は次の 3 種類です。

認証情報

使用側

用途

有効期間

プライマリ API キー

サーバーのみ

すべての Open API を呼び出す（ワールドの管理、ticket の取得、一時 API キーの生成、生成物の照会）

長期間有効

一時 API キー
（SDK では token とも呼ばれます）

クライアント SDK

SDK の HTTP 層の認証（updateToken で設定）。有効期限が切れたら再取得して設定します

デフォルトは 1 分、最大 30 分（expire_in_seconds で設定）。更新が必要です

ticket

クライアント SDK

ルームへの入室に使用する使い捨ての認証情報。サーバー側で取得し、クライアントに配布します

30 分、1 回のみ使用可能

認証情報の受け渡し：
  • プライマリ API キーはサーバーのみで保持し、クライアントに公開しないでください。
  • サーバーはプライマリ API キーを使用して一時 API キーと ticket を生成し、クライアントに配布します。
  • クライアントは updateToken で一時 API キー（token）を設定します。有効期限が切れたら、サーバーに新しいキーを要求して再設定します。ticket を再取得する必要はありません。
  • ticket は 30 分間有効な使い捨ての入室用認証情報で、使用すると無効になります。新しい Travel ごとに新しい ticket が必要です。

認証情報の取得

API Host とプライマリ API キーは Model Studio コンソールで取得します。一時 API キーと ticket は、サーバーから対応する API を呼び出して発行し、クライアントに配布します。
プライマリ API キーはサーバー側に保持してください。クライアント SDK では一時 API キーのみを使用します。プライマリ API キーをクライアントに配布したり、配布用アプリに含めたりしないでください。
API Host と API キーは同じワークスペースに属している必要があります。異なる場合は AccessDenied が返されます。

1. API Host の取得

ワークスペース管理ページで、API Host 列の値をコピーします。この API Host は、サーバーとクライアント SDK の両方で必要です。

2. プライマリ API キーの取得

API キーの取得と設定を参照してください。プライマリ API キーはサーバーのみで保管し、クライアントへの配布や配布用アプリへの組み込みは行わないでください。

3. 一時 API キーの取得

サーバーでプライマリ API キーを使用して一時 API キーの生成エンドポイントを呼び出します。返された一時 API キーをクライアント SDK に配布し、updateToken で設定します。有効期限が切れたら新しいキーを生成して再設定します。ticket を再取得する必要はありません。

4. ticket の取得

サーバーでプライマリ API キーを使用し、ワールドのモードに対応する Get Travel Credential エンドポイントを呼び出します。使い捨ての入室用 ticket を取得し、クライアントに配布します。 各 ticket は 1 つの Travel に対応し、30 分以内に 1 回だけ使用できます。新しい Travel ごとに新しい ticket が必要です。

次のステップ

  • 統合フロー: サーバーがワールドの準備、認証情報の配布、生成物の取得を行い、クライアント SDK がリアルタイム体験を処理します。