Référence de l'API HappyOyster-Directing-Get Travel Credential - Alibaba Cloud Model Studio

Un serveur tiers utilise la clé API principale pour échanger contre un ticket à courte durée de vie et à usage unique, puis le délivre en toute sécurité au client. Ce point de terminaison valide uniquement la propriété du World, son statut et son quota ; il ne crée pas de Travel.

Scope

Un serveur tiers utilise la clé API principale pour échanger contre un ticket à courte durée de vie et à usage unique, puis le délivre en toute sécurité au client. Avant d'appeler, confirmez les points suivants :

Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur 403003).
- Obtenir la clé API principale : Obtenir et configurer une clé API.
Prérequis : Le monde doit appartenir au compte principal actuel et au modèle de mise en scène, et son statut doit être ready. Confirmer via Interroger le statut de construction du monde.
Appelant : Appelé par votre serveur ; le ticket résultant ne doit être délivré qu'à un client sur le point d'entrer immédiatement dans la salle.

Requête HTTP

Singapore

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

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

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

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête	Obtenir l'identifiant de 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`(Requis) Type de contenu de la requête. Ce paramètre doit être défini sur `application/json`.
Authorization `string` (Requis) Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par `sk-`, par ex. `sk-xxx`. Elle est généralement configurée comme variable d'environnement `$DASHSCOPE_API_KEY`. Une clé API temporaire (commençant par `st-`) renvoie `403003`.
Corps de la requête
encryptedWorldId `string` (Requis) Un ID de monde de mise en scène sous le compte principal actuel avec le statut `ready`. Retourné par Créer un monde.

Paramètres de réponse

Échange réussi

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

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

ticket string

Un identifiant de Travel à usage unique préfixé par tk_. Valable pendant 1800 secondes (30 minutes) et utilisable avec succès une seule fois.

expiresIn integer

Validité en secondes, fixée à 1800 (30 minutes).

encryptedWorldId string

L'ID de World chiffré auquel correspond l'identifiant.

États préalables et notes d'appel

Le Monde doit être ready.
Le ticket est valide pendant 30 minutes et ne peut être utilisé avec succès qu'une seule fois ; obtenez-en un nouveau après son expiration ou son utilisation.
Le ticket ne doit être délivré qu'à un client sur le point d'entrer immédiatement dans la salle, et ne doit pas être conservé comme identifiant d'accès à long terme.
L'appel de ce point de terminaison ne crée pas de Travel ; le Travel est créé lorsque l'entrée dans la salle réussit.
Si le quota pour ce Monde n'a pas été acheté, 403007 est retourné ; si la configuration de capacité est temporairement indisponible, 403008 est retourné.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Après avoir obtenu le ticket :

Entrer dans le Travel : le client utilise le ticket pour créer un Travel et obtenir la configuration RTC.