Guia de uso para publicação de lugares | Documentação

A API de publicação de lugares oferece funcionalidade semelhante à publicação na Roblox no Studio, com controle de permissão extra e automação no fluxo de trabalho de liberação contínua. Você pode usar esta API para atualizar lugares existentes de um jogo para uma nova versão, tornando-a útil para automatizar seu fluxo de trabalho de publicação. Por exemplo, você pode chamar esta API a partir de uma ação do GitHub e fazer com que ela envie automaticamente um arquivo de lugar binário para Roblox após testes de integração bem-sucedidos.

Limitações

Esta API suporta apenas requisições HTTPS.
A API de publicação de lugares não atualiza certos tipos de instâncias. Se o seu jogo contiver instâncias do tipo EditableImage, EditableMesh, PartOperation, SurfaceAppearance ou BaseWrap, publique a partir do Studio após modificá-las.

Lugares na Roblox

Jogos na Roblox podem ter múltiplos lugares, com um lugar inicial como ponto de entrada do usuário no seu jogo e outros lugares opcionais que você pode teletransportar usuários entre. Você pode usar a API para publicar tanto o lugar inicial quanto outros lugares do seu jogo com controle de versão.

Antes de poder atualizar um lugar existente de um jogo, você precisa do ID do Lugar e do ID do Universo do jogo. O ID do Lugar identifica o lugar e o ID do Universo identifica o jogo. Cada um é único, mesmo que seu jogo tenha apenas um lugar.

Publicar um lugar

Para publicar um lugar existente de um jogo com a API de Publicação de Lugar:

Crie uma chave de API no Painel do Criador. Certifique-se de realizar as seguintes configurações:
1. Adicione universe-places a Permissões de Acesso.
2. Adicione a operação Write ao seu jogo selecionado.
Obtenha o ID do Universo do jogo em que você deseja publicar o lugar.
1. Navegue até o Painel do Criador.
2. Encontre o jogo com o lugar que você deseja atualizar.
3. Passe o mouse sobre a miniatura do jogo, clique no botão ⋯ e selecione Copiar ID do Universo.
Obtenha o ID do Lugar do lugar que você deseja atualizar.
1. Permaneça na página Criações no Painel do Criador e clique na miniatura do jogo-alvo.
2. No menu de navegação à esquerda, clique na aba Lugares.
3. Encontre o lugar que você deseja atualizar e clique em sua miniatura.
4. O ID do Lugar está na URL redirecionada. Por exemplo, na URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,, o **ID do Lugar** é 111111`.

Adicione a chave de API no cabeçalho x-api-key de uma requisição POST para a API. Os seguintes dois exemplos de requisições referenciam um arquivo de lugar XML (.rbxlx) e um arquivo de lugar binário (.rbxl).

Requisição de Arquivo de Lugar XML
$ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
--header 'x-api-key: <sua-chave-de-api>' \
--header 'Content-Type: application/xml' \
--data-binary @/home/placefiles/place1.rbxlx

Requisiçã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: <sua-chave-de-api>' \
--header 'Content-Type: application/octet-stream' \
--data-binary @/home/placefiles/place1.rbxl

Para executar os comandos, substitua {universeId} e {placeId} pelo ID do Universo e ID do Lugar reais do jogo e lugar que você deseja publicar.

Se você enviar sua requisição corretamente, receberá um corpo de resposta de sucesso com o número da versão do lugar no seguinte formato:
```
Exemplo de Corpo de Resposta
{ "versionNumber": 7 }
```
(Opcional) Verifique o upload no Studio ou no Painel do Criador.