地点发布 API 提供与 Studio 中的发布到 Roblox相似的功能,包括额外的权限控制和连续发布工作流程的自动化。您可以使用此 API 将体验的现有地点升级到新版本,使其对自动化您的发布工作流程有用。例如,您可以从 GitHub 行动中调用此 API,并在成功进行集成测试后自动将二进制位置文件推送到 Roblox。
限制
- 此 API 仅支持 HTTPS 请求。
- 发布地点 API 不会更新某些实例类型。如果您的体验包含 EditableImage 、 EditableMesh 、 PartOperation 、 SurfaceAppearance 或 BaseWrap 实例,在修改后从 Studio 发布。
Roblox 上的地点
Roblox 上的体验可以有多个地点,其中一个 起始地点 作为用户体验入口点,另一个可选地点可以让用户之间传送 。您可以使用 API 发布开始地点或其他版本控制体验的地点。
在您更新体验现有地点之前,您需要地场景的 地点ID 和体验的 宇宙ID 。 地点ID 识别地点, 宇宙ID 识别体验。即使您的体验只有一个场景,每个都是独一无二的。
发布一个场景
要发布经验中的现有地点,使用 地点发布 API:
在创建者仪表板上创建 API 钥匙。请确保您执行以下设置:
- 将 宇宙地点 添加到 访问权限 。
- 将 写入 操作添加到你选择的体验。
获取 体验宇宙ID ,在该体验中发布地场景。
导航到 创建者仪表板。
找到你想要更新的地点的体验。
将鼠标悬停在体验缩略图上,单击 ⋯ 按钮,然后选择 复制宇宙ID 。
获取您想要更新的地方的 地点ID 。
- 在 创建者仪表板 页面上留下,然后单击目标体验的缩略图。
- 在左侧导航菜单中,单击 地点 标签。
- 找到你想要更新的地方并单击其缩略图。
- 地点ID 位于重定向的URL中。例如,在URL中https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure, 地点ID 是111111。
将 API 钥匙添加到 x-api-key 头的 POST 请求到 API。以下两个示例请求引用 Roblox XML 放置文件(.rbxlx和二进制放置文件(.rbxl)。
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二进制地点文件请求$ 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要运行命令,请将 {universeId} 和 {placeId} 替换为体验的实际 宇宙ID 和 地点ID ,然后放置您想要发布的体验。
如果您正确发送请求,您将收到以下格式的成功响应体:地点版本号:
示例响应体{ "versionNumber": 7 }(可选) 在工作室或 创建者仪表板 上验证上传。