HappyOyster-Directing-Get Travel Credential APIリファレンス - Alibaba Cloud Model Studio

サードパーティサーバーはプライマリ API キーを使用して短命かつ単発の ticket と交換し、それを安全にクライアントへ配信します。このエンドポイントは World の所有権、ステータス、およびクォータのみを検証し、Travel は作成しません。

スコープ

サードパーティサーバーはプライマリ API キーを使用して短命かつ単発の ticket と交換し、それを安全にクライアントへ配信します。呼び出す前に、以下を確認してください：

認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
- プライマリ API Key を取得する：API Key の取得と設定。
前提条件：Worldは現在のプライマリアカウントおよびDirectingモデルに属している必要があり、そのステータスはreadyである必要があります。Worldビルドステータスのクエリで確認してください。
呼び出し元：サーバー から呼び出します。結果として得られる ticket は、すぐに入室しようとしているクライアントにのみ配信する必要があります。

HTTP リクエスト

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential

{WorkspaceId} を実際のワークスペースID に置き換えます。

米国（バージニア）

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential

{WorkspaceId} を実際のワークスペースID に置き換えます。

リクエストパラメーター	Travel 資格情報の取得 `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credential' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "encryptedWorldId": "{encryptedWorldId}" }'`
Content-Type`string`（必須）リクエストのコンテンツタイプ。このパラメータは `application/json` に設定する必要があります。
Authorization `string` （必須） API Key 認証。プライマリ API Key のみがサポートされており、`sk-` で始まります（例：`sk-xxx`）。通常、環境変数 `$DASHSCOPE_API_KEY` として設定されます。一時的な API Key（`st-` で始まる）を使用すると `403003` が返されます。
リクエストボディ
encryptedWorldId `string` （必須）現在のプライマリアカウント配下にある、ステータスが`ready`のDirecting World IDです。Worldの作成によって返されます。

レスポンスパラメーター

交換成功

{
    "code": 0,
    "message": null,
    "data": {
        "ticket": "tk_a1b2****",
        "expiresIn": 1800,
        "encryptedWorldId": "enc_a1b2****"
    }
}

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

ticket string

tk_ プレフィックスが付いた1回限りの Travel クレデンシャルです。有効期間は 1800 秒間（30 分間）で、正常に使用できるのは1回のみです。

expiresIn integer

有効期間（秒）、1800（30 分）に固定されています。

encryptedWorldId string

資格情報に対応する暗号化 World ID です。

前提条件となるステータスと呼び出しに関する注意事項

World は ready である必要があります。
ticketの有効期間は30分であり、正常に使用できるのは1回のみです。有効期限切れまたは使用後は、新しいものを取得してください。
ticket は、すぐに入室しようとしているクライアントにのみ配信する必要があり、長期アクセス資格情報として永続化すべきではありません。
このエンドポイントの呼び出しでは Travel は作成されません。Travel は入室が成功した際に作成されます。
この World のクォータが購入されていない場合は 403007 が返されます。キャパシティ設定が一時的に利用できない場合は 403008 が返されます。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ

ticket を取得した後：

Travel への入室：クライアントは ticket を使用して Travel を作成し、RTC 設定を取得します。