Guia de Uso para Publicação de Lugares

Place Publishing API realiza a mesma funcionalidade que Publish to Roblox no Studio, além de controle de permissões extra e automação no fluxo de lançamento contínuo. Você pode usar essa API para atualizar os lugares existentes de uma experiência para uma nova versão, tornando-a útil para automatizar seu fluxo de publicação. Por exemplo, você pode chamar essa API de uma ação do GitHub e ela automaticamente empurra um arquivo de lugar binário para o Roblox Cloud após o teste de integração bem-sucedido.

Lugares no Roblox

Experiências no Roblox podem ter vários lugares, com um lugar de partida como o ponto de entrada do usuário da sua experiência e outros lugares opcionais que você pode teletransportar usuários entre. Você pode usar a API para publicar o lugar de partida ou outros lugares da sua experiência com controle de versão.

Antes de poder atualizar um lugar existente de uma experiência, você precisa do Place ID do locale do Universe ID da experiência. O Place ID identifica o lugar e o Universe ID identifica a experiência. Cada um é único, mesmo que sua experiência tenha apenas um local.

Publicando um Lugar

Para publicar um lugar existente de uma experiência com Place Publishing API :

1. Crie uma chave API no Painel do Criador . Certifique-se de realizar as seguintes configurações:

   1. Adicione Place Publishing a Permissões de Acesso .
   2. Adicione a operação Write à sua experiência selecionada.

2. Obtenha o Universe ID da experiência na qual você deseja publicar o local.

   1. Navegue até o Painel do Criador .

   2. Encontre a experiência com o lugar que você deseja atualização.

   3. Passe o mouse sobre a miniatura da experiência do alvo e clique no botão **** para exibir uma lista de opções e, em seguida, selecione Copiar ID do Universo da lista.

      

3. Obtenha o Place ID do lugar que você deseja atualização.

   1. Fique na página Creations no Creator Dashboard e clique na miniatura da experiência do alvo.
   2. No menu de navegação da esquerda, clique na guia Lugares .
   3. Encontre o lugar que você deseja atualizar e clique em sua miniatura.
   4. O ID do local está no URL redirecionado. Por exemplo, no URL .

4. Adicione a Chave API no cabeçalho x-api-key de uma POST solicitação à API (Interface de Programação para Aplicações). Os dois exemplos a seguir solicitam referência a um arquivo de lugar Roblox XML (.rbxlx ) e a um arquivo de lugar binário (.rbxl ).

   Solicitação de arquivo de localização 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

   Solicitação de Arquivo de Lugar Binário
   $ 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

   Para rodar os comandos, substitua {universeId} e {placeId} com o atual Universe ID e Place ID da experiência e lugar que você deseja publicar.

5. Se você enviar sua solicitação corretamente, você receberá um corpo de resposta de sucesso com o número da versão do lugar no seguinte formato:

   Corpo de Resposta de Exemplo
   { "versionNumber": 7 }

6. (Opcional) Verifique o upload no Studio ou no Painel do Criador .