Guia de uso para publicação de locais

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

A API de publicação de lugar oferece funcionalidade semelhante à de publicar no Roblox no Studio, com controle de permissão extra e automação na fluxo de trabalho de lançamento contínuo.Você pode usar essa API para atualizar locais existentes de uma experiência para uma nova versão, tornando-a útil para automatizar seu fluxo de trabalho de publicação.Por exemplo, você pode chamar esta API de uma ação do GitHub e tê-la automaticamente empurrar um arquivo de local binário para o Roblox após testes de integração bem-sucedidos.

Limitações

Locais no Roblox

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

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

Publicar um local

Para publicar um local existente de uma experiência com API de Publicação de Locais:

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

    1. Adicione universos-locais a Permissões de Acesso .
    2. Adicione Escrever operação à sua experiência selecionada.

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

    1. Navegue até o Painel do Criador.

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

    3. Passe o mouse sobre a miniatura da experiência, clique no botão ⋯ e selecione Copiar ID do Universo .

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

    1. Fique na página Criações na página Painel do Criador e clique na miniatura da experiência alvo.
    2. No menu de navegação à esquerda, clique na aba Locais .
    3. Encontre o local que você deseja atualizar e clique em sua miniatura.
    4. O ID de local está na URL redirecionada. Por exemplo, na URL , o ID de local é .

  4. Adicione a Chave da API no cabeçalho x-api-key de um pedido POST à API (Interface de Programação para Aplicações).Os seguintes dois exemplos de solicitações referenciam um arquivo de local XML do Roblox ( .rbxlx ) e um arquivo de local binário ( .rbxl ).

    Solicitação de Arquivo de Local 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 Local 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 executar os comandos, substitua e com o ID do Universo real e ID do Local da experiência e coloque o que você deseja publicar.

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

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

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