Skip to main content

Obtenir les identifiants d’authentification

Obtenez les identifiants d’authentification requis par le serveur et le client HappyOyster : API Host, clé API principale, clé API temporaire et ticket.

Pour connaître l’architecture globale de HappyOyster, consultez la Présentation.

Identifiants d’authentification

Toutes les API sont authentifiées via la passerelle Alibaba Cloud Model Studio. Trois identifiants sont utilisés :

Identifiant

Utilisé par

Utilisation

Validité

Clé API principale

Serveur uniquement

Appeler toutes les Open API (gérer les mondes, obtenir des tickets, générer des clés API temporaires et consulter les artefacts)

Longue durée

Clé API temporaire
(également appelée token dans le SDK)

SDK client

Authentification de la couche HTTP du SDK (injectée via updateToken) ; il suffit de l’obtenir et de l’injecter à nouveau après expiration

1 minute par défaut, jusqu’à 30 minutes (configuré via expire_in_seconds) ; doit être renouvelée

ticket

SDK client

Identifiant à usage unique pour entrer dans la salle ; obtenu sur le serveur et transmis au client

30 minutes, usage unique

Flux des identifiants :
  • La clé API principale est conservée uniquement sur votre serveur et ne doit jamais être exposée au client.
  • Votre serveur utilise la clé API principale pour générer la clé API temporaire et le ticket, puis les transmet au client.
  • Le client injecte la clé API temporaire (token) via updateToken. À son expiration, demandez-en une nouvelle à votre serveur et injectez-la à nouveau. Il n’est pas nécessaire d’obtenir un nouveau ticket.
  • Le ticket est un identifiant d’entrée dans la salle à usage unique, valable 30 minutes et invalidé après utilisation. Chaque nouveau Travel nécessite un nouveau ticket.

Obtenir les identifiants d’authentification

L’API Host et la clé API principale s’obtiennent dans la console Model Studio. La clé API temporaire et le ticket sont émis par votre serveur via les API correspondantes, puis transmis au client.
La clé API principale doit rester côté serveur ; les SDK clients doivent utiliser uniquement la clé API temporaire. Ne transmettez jamais la clé API principale à un client et ne l’intégrez pas dans une application distribuée.
L’API Host et la clé API doivent appartenir au même espace de travail ; sinon, AccessDenied est renvoyé.

1. Obtenir l’API Host

Sur la page Gestion des espaces de travail, copiez la valeur de la colonne API Host. Votre serveur et le SDK client ont tous deux besoin de cet API Host.

2. Obtenir la clé API principale

Consultez Obtenir et configurer une clé API. La clé API principale doit être stockée uniquement sur votre serveur ; ne la transmettez pas au client et ne l’intégrez pas dans une application distribuée.

3. Obtenir la clé API temporaire

Sur le serveur, utilisez la clé API principale pour appeler le point de terminaison Générer une clé API temporaire, puis transmettez la clé API temporaire renvoyée au SDK client et injectez-la via updateToken. À son expiration, générez-en une nouvelle et injectez-la à nouveau. Il n’est pas nécessaire d’obtenir un nouveau ticket.

4. Obtenir le ticket

Sur le serveur, utilisez la clé API principale pour appeler le point de terminaison Get Travel Credential correspondant au mode de votre monde, obtenez le ticket d’entrée dans la salle à usage unique et transmettez-le au client : Chaque ticket est associé à un seul Travel et peut être utilisé une fois dans les 30 minutes ; chaque nouveau Travel nécessite un nouveau ticket.

Étapes suivantes

  • Flux d’intégration: Le serveur prépare les mondes, transmet les identifiants et récupère les artefacts ; le SDK client gère l’expérience en temps réel.