Obtenga las credenciales de autenticación requeridas por el servidor y el cliente de HappyOyster: API Host, API Key principal, API Key temporal y ticket.
Para consultar la arquitectura general de HappyOyster, véase la Descripción general.
Credenciales de autenticación
Todas las APIs se autentican a través de la puerta de enlace de Alibaba Cloud Model Studio. Intervienen tres credenciales:
Credencial | Utilizado por | Propósito | Validez |
|---|---|---|---|
API Key principal | Solo servidor | Invoca todas las Open APIs (gestionar mundos, canjear tickets, generar API Keys temporales, consultar artefactos) | De larga duración |
API Key temporal | SDK del cliente | Autenticación de capa HTTP para el SDK (inyectada mediante | Predeterminado de 1 minuto, hasta 30 minutos (configurable mediante |
ticket | SDK del cliente | Credencial de un solo uso para ingresar a la sala; se canjea en el servidor y se entrega al cliente | 30 minutos, un solo uso |
Flujo de credenciales:
- La API Key principal debe permanecer exclusivamente en su servidor y nunca debe exponerse al cliente.
- Su servidor utiliza la API Key principal para generar la API Key temporal y el ticket, y luego los entrega al cliente.
- El cliente inyecta la API Key temporal (token) mediante
updateToken. Cuando caduque, solicite una nueva a su servidor e inyéctela nuevamente; no es necesario volver a canjear elticket. - El ticket es una credencial de entrada a la sala de un solo uso, válida durante 30 minutos, y se invalida tras su uso. Cada nuevo Travel requiere un ticket nuevo.
Obtener credenciales de autenticación
El API Host y la API Key principal se obtienen desde la consola de Model Studio. La API Key temporal y el ticket son emitidos por su servidor a través de las APIs correspondientes y entregados al cliente.
ImportanteLa API Key principal debe permanecer en el lado del servidor; los SDK de cliente deben utilizar únicamente la API Key temporal. Nunca entregue la API Key principal a un cliente ni la incluya en una aplicación para su distribución.
NotaEl API Host y la API Key deben pertenecer al mismo espacio de trabajo; de lo contrario, se devuelve AccessDenied.
1. Obtener el API Host
En la página de Workspace Management, copie el valor de la columna API Host. Tanto su servidor como el SDK de cliente necesitan este API Host.
2. Obtener la API Key principal
Consulte Obtener y configurar una API Key. La API Key principal debe almacenarse únicamente en su servidor; no la entregue al cliente ni la incluya en una aplicación para su distribución.
3. Obtener la API Key temporal
En el servidor, utilice la API Key principal para invocar el endpoint Generate Temporary API Key, luego entregue la API Key temporal devuelta al SDK de cliente e inyéctela mediante updateToken. Cuando caduque, genere una nueva e inyéctela nuevamente; no es necesario volver a canjear el ticket.
4. Obtener el ticket
En el servidor, utilice la API Key principal para invocar el endpoint Get Travel Credential correspondiente al modo de su mundo, obtenga el ticket de entrada a la sala de un solo uso y entréguelo al cliente:
- Adventure: HappyOyster-Adventure-Get Travel Credential
- Directing: HappyOyster-Directing-Get Travel Credential
- Acting: HappyOyster-Acting-Get Travel Credential
Cada ticket está vinculado uno a uno con un Travel y puede usarse una sola vez dentro de 30 minutos; cada nuevo Travel requiere un ticket nuevo.
Siguientes pasos
- Flujo de integración: El servidor prepara los mundos, entrega las credenciales y recupera los artefactos; el SDK de cliente gestiona la experiencia en tiempo real.