Guide d'utilisation pour la publication de lieux

L'API de publication de lieux offre une fonctionnalité similaire à la publication sur Roblox dans Studio, avec un contrôle des permissions supplémentaire et une automatisation dans le flux de travail de publication continue. Vous pouvez utiliser cette API pour mettre à jour des lieux existants d'un jeu vers une nouvelle version, ce qui est utile pour automatiser votre flux de travail de publication. Par exemple, vous pouvez appeler cette API depuis une action GitHub et la faire automatiquement pousser un fichier de lieu binaire sur Roblox après des tests d'intégration réussis.

Limitations

• Cette API ne prend en charge que les requêtes HTTPS.
• L'API de publication de lieux ne met pas à jour certains types d'instances. Si votre jeu contient des instances de EditableImage, EditableMesh, PartOperation, SurfaceAppearance, ou BaseWrap, publiez depuis Studio après les avoir modifiées.

Lieux sur Roblox

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

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

Publier un lieu

Pour publier un lieu existant d'un jeu avec l'API de publication de lieux :

1. Créez une clé API sur le Tableau de bord des créateurs. Assurez-vous de configurer les paramètres suivants :

   1. Ajoutez universe-places dans Permissions d'accès.
   2. Ajoutez l'opération Write à votre jeu sélectionné.

2. Obtenez l'ID d'univers du jeu dans lequel vous souhaitez publier le lieu.

   1. Naviguez vers le Tableau de bord des créateurs.

   2. Trouvez le jeu avec le lieu que vous souhaitez mettre à jour.

   3. Survolez la miniature du jeu, cliquez sur le bouton ⋯ et sélectionnez Copier l'ID d'univers.

      

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

   1. Restez sur la page Créations sur le Tableau de bord des créateurs et cliquez sur la miniature du jeu cible.
   2. Dans le menu de navigation à gauche, cliquez sur l'onglet Lieux.
   3. Trouvez le lieu que vous souhaitez mettre à jour et cliquez sur sa miniature.
   4. L'ID de lieu se trouve dans l'URL redirigée. Par exemple, dans l'URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,, l'**ID de lieu** est 111111`.

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

   Requête 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

   Requête 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 {universeId} et {placeId} par les véritables ID d'univers et ID de lieu du jeu et du lieu que vous souhaitez publier.

5. Si vous envoyez correctement votre demande, vous recevrez 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. (Optionnel) Vérifiez le téléchargement dans Studio ou sur le Tableau de bord des créateurs.