Um servidor de terceiros usa a Chave de API primária para trocar por um ticket de curta duração e uso único, e então o entrega com segurança ao cliente. Este endpoint valida apenas a propriedade, o status e a cota do Mundo; ele não cria uma Travel.
Escopo
Um servidor de terceiros usa a Chave de API primária para trocar por um ticket de curta duração e uso único, e então o entrega com segurança ao cliente. Antes de chamar, confirme o seguinte:
-
Autenticação: Apenas a API Key primária é suportada; API Keys temporárias não podem ser usadas (código de erro
403003).- Obtenha a API Key primária: Obter e configurar uma API Key.
-
Pré-requisitos: O Mundo deve pertencer à conta principal atual e ao modelo de Direção, e seu status deve ser
ready. Confirme via Consultar Status de Construção do Mundo. -
Chamador: Chamado pelo seu servidor; o
ticketresultante deve ser entregue apenas a um cliente que esteja prestes a entrar na sala imediatamente.
Solicitação HTTP
- Singapore
- EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/get-travel-credentialSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Content-Typestring(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json. | |
Authorization string (Obrigatório)Autenticação por API Key. Apenas a API Key primária é suportada; ela começa com sk-, ex. sk-xxx. É tipicamente configurada como a variável de ambiente $DASHSCOPE_API_KEY. Uma API Key temporária (começando com st-) retorna 403003. | |
Corpo da solicitação | |
encryptedWorldId string (Obrigatório)Um ID de Mundo de Direção na conta principal atual com status ready. Retornado por Criar Mundo. |
Parâmetros de resposta |
|
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro. | |
message stringMensagem de erro. null em caso de sucesso. | |
data objectDados da resposta. null em caso de falha.
Propriedades ticket stringUma credencial de Travel de uso único com prefixo tk_. Válida por 1800 segundos (30 minutos) e pode ser usada com sucesso apenas uma vez.expiresIn integerValidade em segundos, fixada em 1800 (30 minutos).encryptedWorldId stringO ID criptografado do Mundo ao qual a credencial corresponde. |
Estados pré-requisitos e notas de chamada
- O World deve estar
ready. - O
ticketé válido por 30 minutos e pode ser usado com sucesso apenas uma vez; obtenha um novo após ele expirar ou ter sido usado. - O
ticketdeve ser entregue apenas a um cliente que esteja prestes a entrar na sala imediatamente, e não deve ser persistido como uma credencial de acesso de longo prazo. - Chamar este endpoint não cria uma Travel; a Travel é criada quando a entrada na sala é bem-sucedida.
- Se a cota para este World não tiver sido comprada,
403007será retornado; se a configuração de capacidade estiver temporariamente indisponível,403008será retornado.
Códigos de erro
Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.
Próximos passos
Após obter o ticket:
- Entrar na Travel: o cliente usa o
ticketpara criar uma Travel e obter a configuração RTC.