發布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 }(可選) 在 Studio 或 創作者面板 上驗證上傳。