Guide d'utilisation pour la publication de lieu

L'API de publication de lieu offre une fonctionnalité similaire à celle de publication sur Roblox dans Studio, avec un contrôle de permission supplémentaire et une automatisation dans le flux de travail de sortie continue.Vous pouvez utiliser cette API pour mettre à jour les lieux existants d'une expérience à une nouvelle version, ce qui la rend utile pour automatiser votre flux de travail de publication.Par exemple, vous pouvez appeler cette API à partir d'une action GitHub et la faire pousser automatiquement un fichier de lieu binaire dans Roblox après un test d'intégration réussi.

Limites

• Cette API ne prend en charge que les demandes HTTPS.
• L'API de publication de lieu ne met pas à jour certains types d'instance.Si votre expérience contient EditableImage , EditableMesh , PartOperation , SurfaceAppearance ou BaseWrap instances, publiez à partir de Studio après les avoir modifiées.

Lieux sur Roblox

Les expériences sur Roblox peuvent avoir plusieurs endroits, avec un lieu de départ comme point d'entrée de l'utilisateur de votre expérience et d'autres endroits optionnels que vous pouvez téléporter les utilisateurs entre .Vous pouvez utiliser l'API pour publier soit le lieu de départ, soit d'autres lieux de votre expérience avec le contrôle de version.

Avant de pouvoir mettre à jour un lieu existant d'une expérience, vous avez besoin de l'ID de lieu du emplacementet de l'ID d'univers de l'expérience.L'ID de lieu identifie le lieu et l'ID d'univers identifie l'expérience.Chacun est unique, même si votre expérience n'a qu'un seul emplacement.

Publier un emplacement

Pour publier un lieu existant d'une expérience avec API de publication de lieu :

1. Créez une clé API sur le tableau de bord du créateur . Assurez-vous d'effectuer les paramètres suivants :

   1. Ajoutez lieux universels à permissions d'accès .
   2. Ajoutez l'opération Écrire à votre expérience sélectionnée.

2. Obtenez le ID de l'univers de l'expérience dans laquelle vous voulez publier l'emplacement.

   1. Accédez à la tableau de bord du créateur.

   2. Trouvez l'expérience avec l'endroit que vous voulez mettre à mise à jour.

   3. Passez la souris sur la miniaturede l'expérience, cliquez sur le bouton ⋯ et sélectionnez Copier l'ID de l'univers .

      

3. Obtenez l'ID de lieu Place ID du lieu que vous voulez mettre à jour.

   1. Restez sur la page créations sur tableau de bord du créateur et cliquez sur la vignette de l'expérience cible.
   2. Dans le menu de navigation à gauche, cliquez sur l'onglet Lieux .
   3. Trouvez l'endroit que vous voulez mettre à jour et cliquez sur sa vignette.
   4. L'ID de lieu est dans l'URL redirigée. Par exemple, dans l'URL , l'ID de lieu est .

4. Ajoutez la clé API dans l'en-tête x-api-key d'une demande POST à l'API.Les deux demandes d'exemple suivantes font référence à un fichier de lieu XML de Roblox ( .rbxlx ) et à un fichier de lieu binaire ( .rbxl ).

   Demande de fichier de lieu XML
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/xml' \
   --data-binary @/home/placefiles/place1.rbxlx

   Demande de fichier de lieu binaire
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/octet-stream' \
   --data-binary @/home/placefiles/place1.rbxl

   Pour exécuter les commandes, remplacez et par l'ID de l'univers réel et l'ID de lieu de l'expérience et placez celle que vous voulez publier.

5. Si vous envoyez votre demande correctement, vous recevez un corps de réponse de succès avec le numéro de version du lieu dans le format suivant :

   Exemple de corps de réponse
   { "versionNumber": 7 }

6. (Facultatif) Vérifiez le téléchargement dans Studio ou sur tableau de bord du créateur.