Skip to main content

Referencia de la API de HappyOyster-Directing-Get Travel Credential

Un servidor de terceros utiliza la API Key principal para intercambiarla por un ticket de corta duración y un solo uso, y luego lo entrega de forma segura al cliente. Este endpoint solo valida la propiedad, el estado y la cuota del mundo; no crea un viaje.

Ámbito

Un servidor de terceros utiliza la API Key principal para intercambiarla por un ticket de corta duración y un solo uso, y luego lo entrega de forma segura al cliente. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
  • Requisitos previos: El Mundo debe pertenecer a la cuenta principal actual y al modelo de Dirección, y su estado debe ser ready. Confírmelo mediante Consultar estado de construcción del mundo.
  • Caller: Llamado por su servidor; el ticket resultante debe entregarse únicamente a un cliente que esté a punto de entrar en la sala inmediatamente.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credentialReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Obtener credencial de viaje
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-Typestring(Requerido)Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.
Authorization string (Requerido)Autenticación mediante API Key. Solo se admite la API Key principal; comienza con sk-, p. ej., sk-xxx. Normalmente se configura como la variable de entorno $DASHSCOPE_API_KEY. Una API Key temporal (que comienza con st-) devuelve 403003.
Cuerpo de la solicitud
encryptedWorldId string (Requerido)Un ID de Mundo de Dirección bajo la cuenta principal actual con estado ready. Devuelto por Crear Mundo.

Parámetros de respuesta

  • Intercambio exitoso
{
    "code": 0,
    "message": null,
    "data": {
        "ticket": "tk_a1b2****",
        "expiresIn": 1800,
        "encryptedWorldId": "enc_a1b2****"
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

ticket stringUna credencial de viaje de un solo uso con el prefijo tk_. Válida por 1800 segundos (30 minutos) y se puede utilizar correctamente solo una vez.expiresIn integerValidez en segundos, fija en 1800 (30 minutos).encryptedWorldId stringEl ID de mundo cifrado al que corresponde la credencial.

Estados previos y notas de llamada

  • El mundo debe estar ready.
  • El ticket es válido durante 30 minutos y solo se puede utilizar con éxito una vez; obtenga uno nuevo después de que caduque o haya sido utilizado.
  • El ticket debe entregarse únicamente a un cliente que esté a punto de entrar en la sala inmediatamente, y no debe conservarse como una credencial de acceso a largo plazo.
  • Llamar a este endpoint no crea un viaje; el viaje se crea cuando entrar en la sala tiene éxito.
  • Si no se ha comprado la cuota para este mundo, se devuelve 403007; si la configuración de capacidad no está disponible temporalmente, se devuelve 403008.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de obtener el ticket:
  • Enter Travel: el cliente utiliza el ticket para crear un viaje y obtener la configuración RTC.