Panduan penggunaan untuk penerbitan tempat

API penerbitan tempat menawarkan fungsionalitas serupa dengan penerbitan ke Roblox di Studio, dengan kontrol izin tambahan dan otomatisasi dalam alur kerja rilis terus-menerus. Anda dapat menggunakan API ini untuk memperbarui tempat yang ada dari sebuah game ke versi baru, sehingga berguna untuk mengotomatiskan alur kerja penerbitan Anda. Misalnya, Anda dapat memanggil API ini dari tindakan GitHub dan membuatnya secara otomatis mendorong file tempat biner ke Roblox setelah pengujian integrasi berhasil.

Batasan

• API ini hanya mendukung permintaan HTTPS.
• API penerbitan tempat tidak memperbarui jenis instansi tertentu. Jika game Anda mengandung instansi EditableImage, EditableMesh, PartOperation, SurfaceAppearance, atau BaseWrap, terbitkan dari Studio setelah memodifikasinya.

Tempat di Roblox

Game di Roblox dapat memiliki beberapa tempat, dengan satu tempat awal sebagai titik masuk pengguna ke game Anda dan tempat-tempat lain yang opsional yang dapat Anda teleportasikan pengguna antara. Anda dapat menggunakan API untuk menerbitkan baik tempat awal atau tempat lain dari game Anda dengan kontrol versi.

Sebelum Anda dapat memperbarui tempat yang ada dari sebuah game, Anda memerlukan ID Tempat dari tempat tersebut dan ID Universe dari game tersebut. ID Tempat mengidentifikasi tempat dan ID Universe mengidentifikasi game. Masing-masing unik bahkan jika game Anda hanya memiliki satu tempat.

Menerbitkan tempat

Untuk menerbitkan tempat yang ada dari sebuah game dengan API Penerbitan Tempat:

1. Buat kunci API di Dasbor Pembuat. Pastikan Anda melakukan pengaturan berikut:

   1. Tambahkan universe-places ke Izin Akses.
   2. Tambahkan operasi Tulisan ke game yang Anda pilih.

2. Dapatkan ID Universe dari game di mana Anda ingin menerbitkan tempat tersebut.

   1. Arahkan ke Dasbor Pembuat.

   2. Temukan game dengan tempat yang ingin Anda perbarui.

   3. Arahkan kursor ke thumbnail game, klik tombol ⋯ dan pilih Salin ID Universe.

      

3. Dapatkan ID Tempat dari tempat yang ingin Anda perbarui.

   1. Tetap di halaman Kreasi di Dasbor Pembuat dan klik thumbnail game target.
   2. Di menu navigasi sebelah kiri, klik tab Tempat.
   3. Temukan tempat yang ingin Anda perbarui dan klik thumbnail-nya.
   4. ID Tempat terdapat dalam URL yang diarahkan. Misalnya, pada URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,, **ID Tempat** adalah 111111`.

4. Tambahkan Kunci API dalam header x-api-key dari permintaan POST ke API. Dua contoh permintaan berikut merujuk ke file tempat XML Roblox (.rbxlx) dan file tempat biner (.rbxl).

   Permintaan File Tempat 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

   Permintaan File Tempat Biner
   $ 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

   Untuk menjalankan perintah, ganti {universeId} dan {placeId} dengan ID Universe dan ID Tempat yang sebenarnya dari game dan tempat yang ingin Anda terbitkan.

5. Jika Anda mengirim permintaan Anda dengan benar, Anda akan menerima badan respons sukses dengan nomor versi tempat dalam format berikut:

   Contoh Badan Respons
   { "versionNumber": 7 }

6. (Opsional) Verifikasi unggahan di Studio atau di Dasbor Pembuat.