Hướng dẫn sử dụng cho việc xuất bản nơi

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

API xuất bản nơi cung cấp chức năng tương tự với xuất bản vào Roblox trong Studio, với thêm kiểm soát quyền và tự động hóa trong luồng công việc phát hành liên tụcBạn có thể sử dụng API này để cập nhật các địa điểm hiện có của một trải nghiệm lên phiên bản mới, làm cho nó hữu ích để tự động hóa quy trình xuất bản của bạn.Ví dụ, bạn có thể gọi API này từ một hành động của GitHub và có nó tự động đẩy một tập tin vị trí nhị phân vào Roblox sau khi thành công kiểm tra tích hợp.

Hạn chế

  • API này chỉ hỗ trợ các yêu cầu HTTPS.
  • API xuất bản nơi không cập nhật một số loại instance nhất định.Nếu trải nghiệm của bạn có chứa EditableImage , EditableMesh , PartOperation , SurfaceAppearance hoặc BaseWrap ví dụ, xuất bản từ Studio sau khi chỉnh sửa chúng.

Nơi trên Roblox

Các trải nghiệm trên Roblox có thể có nhiều nơi, với một nơi bắt đầu như điểm nhập của người dùng và những nơi khác tùy chọn mà bạn có thể dịch chuyển người dùng giữa .Bạn có thể sử dụng API để xuất bản vị trí bắt đầu hoặc các vị trí khác của trải nghiệm với kiểm soát phiên bản.

Trước khi bạn có thể cập nhật một địa điểm hiện có của một trải nghiệm, bạn cần ID địa điểm và ID vũ trụ của trải nghiệm.ID Nơi xác định nơi và ID Vũ trụ xác định trải nghiệm.Mỗi cái đều là duy nhất ngay cả khi trải nghiệm của bạn chỉ có một nơi.

Xuất bản một địa điểm

Để xuất bản một nơi hiện có của một trải nghiệm với API Xuất bản nơi :

  1. Tạo một chìa khóa API trên Bảng điều khiển Nhà sáng tạo . Hãy chắc chắn rằng bạn thực hiện các cài đặt sau:

    1. Thêm không gian vũ trụ vào Quyền truy cập .
    2. Thêm Viết hoạt động vào trải nghiệm được chọn của bạn.
  2. Nhận ID Vũ trụ của trải nghiệm mà bạn muốn xuất bản địa điểm.

    1. Điều hướng đến Bảng điều khiển Nhà sáng tạo.

    2. Tìm trải nghiệm với nơi bạn muốn cập nhật.

    3. Chuyển con trỏ qua hình ảnh thu nhỏ của trải nghiệm, nhấp vào nút và chọn Sao chép ID Vũ trụ .

  3. Lấy ID địa điểm của nơi bạn muốn cập nhật.

    1. Ở lại trang Sáng tạo trên Bảng điều khiển Nhà sáng tạo và nhấp vào hình ảnh thumbnail của trải nghiệm mục tiêu.
    2. Trong menu điều hướng bên trái, nhấp vào tab Nơi .
    3. Tìm nơi bạn muốn cập nhật và nhấp vào hình xem trước của nó.
    4. ID nơi ở trong URL được chuyển hướng. Ví dụ, trong URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure, ID nơi111111 .
  4. Thêm chìa khóa API trong x-api-key tiêu đề của một POST yêu cầu đến API.Hai ví dụ sau đây tham chiếu đến tập tin nơi XML của Roblox ( .rbxlx ) và tập tin nơi nhị phân ( .rbxl ).

    Yêu cầu tệp nơi 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
    Yêu cầu tệp chỗ nhị phân

    $ 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

    Để chạy các lệnh, thay thế {universeId}{placeId} bằng ID thực tế của Vũ trụID địa điểm của trải nghiệm và đặt nơi bạn muốn xuất bản.

  5. Nếu bạn gửi yêu cầu của mình chính xác, bạn nhận được một cơ thể phản hồi thành công với số phiên bản nơi trong định dạng sau:

    Ví dụ về cơ thể phản hồi

    { "versionNumber": 7 }
  6. (Tùy chọn) Xác minh việc tải lên trong Studio hoặc trên Bảng điều khiển Nhà sáng tạo.