Skip to main content

Flux d'intégration

Votre serveur prépare les mondes et exporte les artefacts via les Open API HappyOyster ; le SDK client gère la connexion RTC et l'interaction en temps réel.

HappyOyster suit une architecture serveur + client : votre serveur gère les mondes et les artefacts via les Open API, et le SDK client fournit l'expérience en temps réel. Avant de commencer, complétez Obtenir les identifiants d'authentification.
  • Les Open API côté serveur sont divisées par mode d'expérience en Aventure, Réalisation et Jeu d'acteur. Choisissez les points de terminaison correspondant à votre mode.
  • Un Monde et un Voyage sont strictement liés au modèle qui les a créés ; l'accès inter-modèles renvoie 403001 (monde) ou 404000 (voyage).
  • Le SDK n'est pas responsable de la création ou de la gestion des mondes ; il fournit uniquement l'expérience en temps réel côté client.

1. Préparer un monde (Open API serveur)

  1. Créer un monde, en utilisant le point de terminaison correspondant à votre mode : Aventure-Créer un monde / Réalisation-Créer un monde / Jeu d'acteur-Créer un monde.
  2. Interroger l'état de construction (toutes les 3–5 secondes) jusqu'à ready : Avenue-Interroger l'état de construction du monde / Réalisation-Interroger l'état de construction du monde / Jeu d'acteur-Interroger l'état de construction du monde.
  3. Échanger contre un ticket : Avec la clé API principale, appelez Aventure-Obtenir l'identifiant de voyage / Réalisation-Obtenir l'identifiant de voyage / Jeu d'acteur-Obtenir l'identifiant de voyage pour obtenir un ticket à usage unique.
  4. Fournir les identifiants au client : Envoyez le ticket ainsi que la clé API temporaire (utilisée comme token du SDK) au client.

2. Expérience en temps réel (SDK client)

Le SDK gère la connexion RTC, la lecture vidéo et les commandes d'interaction.
  1. Initialiser le SDK : initialize + updateToken — injectez l'hôte API et la clé API temporaire.
  2. Démarrer la session : startTravel(ticket) ; le SDK entre dans la salle et établit la connexion automatiquement.
  3. Attacher la vidéo : Ajoutez la vue renvoyée par attachVideo() à votre mise en page. Pour le mode Jeu d'acteur, définissez l'orientation du conteneur selon le aspectRatio renvoyé lors de l'entrée dans la salle.
  4. Interaction temps réel :
    • Aventure : Appelez sendCommand pour envoyer des commandes de direction / caméra / action.
    • Réalisation : Appelez sendInstruct pour envoyer des instructions textuelles qui font avancer l'histoire.
    • Jeu d'acteur : Appelez sendInstruct pour envoyer des instructions textuelles.
  5. Contrôle de session :
    • Aventure : La pause et le rembobinage ne sont pas pris en charge.
    • Réalisation : Prend en charge pause, rewind et resume.
    • Jeu d'acteur : Prend en charge pause et resume ; rewind n'est pas pris en charge.
  6. Terminer la session : endTravel libère le RTC et les ressources.

3. Récupérer les artefacts (Open API serveur)

Après la fin du voyage, interrogez avec la clé API principale sur Aventure-Interroger les artefacts de voyage / Réalisation-Interroger les artefacts de voyage / Jeu d'acteur-Interroger les artefacts de voyage jusqu'à composeStatus = ready. Pour une diffusion externe, nous recommandons video.withInstructionAndWatermark (composé avec instructions et filigrane).

Étapes suivantes