Skip to main content

Obter credenciais de autenticação

Obtenha as credenciais de autenticação necessárias para o servidor e o cliente do HappyOyster: API Host, API Key principal, API Key temporária e ticket.

Para conhecer a arquitetura geral do HappyOyster, consulte a Visão geral.

Credenciais de autenticação

Todas as APIs são autenticadas pelo gateway do Alibaba Cloud Model Studio. São usadas três credenciais:

Credencial

Usado por

Finalidade

Validade

API Key principal

Somente servidor

Chama todas as Open APIs (gerenciar mundos, obter tickets, gerar API Keys temporárias e consultar artefatos)

Longa duração

API Key temporária
(também chamada de token no SDK)

SDK do cliente

Autenticação da camada HTTP do SDK (injetada via updateToken); basta obter e injetar novamente após a expiração

Padrão de 1 minuto, até 30 minutos (configurado via expire_in_seconds); deve ser renovada

ticket

SDK do cliente

Credencial de uso único para entrar na sala; obtida no servidor e enviada ao cliente

30 minutos, uso único

Fluxo de credenciais:
  • A API Key principal é mantida somente no seu servidor e nunca deve ser exposta ao cliente.
  • Seu servidor usa a API Key principal para gerar a API Key temporária e o ticket e os envia ao cliente.
  • O cliente injeta a API Key temporária (token) via updateToken. Quando ela expirar, solicite uma nova ao seu servidor e injete-a novamente. Não é necessário obter outro ticket.
  • O ticket é uma credencial de entrada na sala de uso único, válida por 30 minutos e invalidada após o uso. Cada novo Travel exige um novo ticket.

Obter credenciais de autenticação

O API Host e a API Key principal são obtidos no console do Model Studio. A API Key temporária e o ticket são emitidos pelo seu servidor por meio das APIs correspondentes e enviados ao cliente.
A API Key principal deve permanecer no servidor; os SDKs do cliente devem usar apenas a API Key temporária. Nunca envie a API Key principal a um cliente nem a inclua em um aplicativo para distribuição.
O API Host e a API Key devem pertencer ao mesmo espaço de trabalho; caso contrário, será retornado AccessDenied.

1. Obter o API Host

Na página Gerenciamento de espaços de trabalho, copie o valor da coluna API Host. Tanto o servidor quanto o SDK do cliente precisam desse API Host.

2. Obter a API Key principal

Consulte Obter e configurar uma API Key. A API Key principal deve ser armazenada somente no seu servidor; não a envie ao cliente nem a inclua em um aplicativo para distribuição.

3. Obter a API Key temporária

No servidor, use a API Key principal para chamar o endpoint Gerar API Key temporária, envie a API Key temporária retornada ao SDK do cliente e injete-a via updateToken. Quando ela expirar, gere uma nova e injete-a novamente. Não é necessário obter outro ticket.

4. Obter o ticket

No servidor, use a API Key principal para chamar o endpoint Get Travel Credential correspondente ao modo do seu mundo, obtenha o ticket de entrada na sala de uso único e envie-o ao cliente: Cada ticket é vinculado exclusivamente a um Travel e pode ser usado uma vez em até 30 minutos; cada novo Travel exige um novo ticket.

Próximas etapas

  • Fluxo de integração: O servidor prepara os mundos, envia as credenciais e recupera os artefatos; o SDK do cliente gerencia a experiência em tempo real.