Mở Cloud xác thực và ủy quyền API bằng cách sử dụng API Keys, cho phép bạn thêm quyền truy cập và kiểm soát an toàn cho tài nguyên nhất định trong trải nghiệm của bạn, chẳng hạn như lưu trữ dữ liệu và nơi.
Tất cả các API mở trên Cloud yêu cầu bạn tạo một chìa khóa API với các quyền truy cập hợp lệ và bao gồm một đầu mối x-api-key trong yêu cầu của bạn, cho phép ứng dụng đăng nhập vào Cloud on behalf của bạn.
Tạo các chìa khóa API
Bạn có thể tạo và cấu hình các API cho các trải nghiệm của riêng bạn hoặc các trải nghiệm thuộc sở hữu nhóm (một Roblox nhóm cho phép nhiều người sáng tạo làm việc trên cùng một trải nghiệm, sử dụng cùng một tài nguyên và chia sẻ các chìa khóa API).
Bạn phải là chủ nhóm hoặc được giao vai trò trong nhóm mà có quyền quản lý chìa khóa API để tạo một chìa khóa API cho nhóm của bạn. Một thành viên trong nhóm chỉ có thể tạo một chìa khóa API với cùng các quyền truy cập nguồn lực của vai trò c
Để tạo một chìa khóa API:
Navigate to the Bảng điều khiển của người dùng Creator .
(Bắt buộc) Nhấp vào dụng cụ Dropdown Creator Hub để lựa chọn một nhóm nếu bạn đang tạo API Key cho một nhóm.
Trong menu navigazione bên trái, chọn Mở Cloud → Chìa khóa API .
Nhấp vào nút Tạo chìa khóa API .
Nhập một tên độc đáo cho API của bạn. Sử dụng một tên có thể giúp bạn ghi nhớ mục đích sau đó, chẳng hạn như PLACE_PUBLISHING_KEY để phát sóng những nơi đến trải nghiệm của bạn.
Trong phần Cài đặt quyền truy cập , hãy chọn một API từ menu Chọn hệ thống API và nhấp vào nút Thêm hệ thống API . Lặp lại bước này nếu bạn cần thêm nhiều API vào chìa khóa.
Chọn trải nghiệm bạn muốn truy cập với API chìa khóa.
Từ danh sách Hoạt động kinh nghiệm , chọn hoạt động bạn muốn bật cho API chìa khóa.
Nhiều hoạt động trong API reference bao gồm các khoảng phép quyền cần thiết. Ví dụ, hoạt động flush memory store yêu cầu quyền universe.memory-store:flush.
Trong phần Bảo mật , hãy cài đặt truy cập IP bằng cách sử dụng CIDR notation , nếu không bạn khô
(Tùy chọn) : Để thêm bảo vệ cơ bản cho tài nguyên của bạn, hãy cài đặt một ngày hết hạn rõ ràng để đảm bảo rằng chìa khóa của bạn tự động dừng hoạt động sau ngày đó.
Click the Lưu và tạo chìa khóa button.
Bản sao và lưu mật mã API đến một vị trí an toàn mà không phải là không một kho chứa công khai của mã của bạn.
Kiểm tra chìa khóa API của bạn đã tạo trên trang Credentials của Creator Dashboard .
Mật mã API tương đương với mật mã của ứng dụng của bạn. Không bao giờ chia sẻ với những bên không tin cậy, chẳng hạn như bất kỳ ai ngoài đội phát triển của bạn. Đó là một trong những lý do tại sao bạn không bao giờ nên chia sẻ mật mã API của bạn với bất kỳ ai ngoài tầm với của bạn. </
Các quyền truy cập API đã được chủ sở hữu nhóm
Các chủ nhóm có thể quản lý quyền quản lý API của nhóm để các thành viên trong nhóm có các cấp độ kiểm soát của API dựa trên vai trò và quyền truy cập trong nhóm. Các tình huống cũng có thể tự động huỷ bỏ quyền quản lý API cho các thành viên trong nhóm.
Cấp quyền truy cập
Là một chủ nhóm, bạn có thể cấp quyền Quản lý tất cả các chìa khóa API cho các vai trò trong nhóm của bạn. Các thành viên với quyền này có tất cả các quyền mà một chủ nhóm có đối với các chìa khóa API, bao gồm khả năng tạo, xem, thu hồi, hu
Bạn cũng có thể cấp quyền Quản lý các chìa khóa API của riêng bạn cho các vai trò trong nhóm của bạn. Điều này cho phép các thành viên chỉ tạo và xem các chìa khóa mà họ sở hữu thay vì có thể quản lý các chìa khóa của người khác.
Lỗi không xác nhận
Có nhiều tình huống mà cho phép tự động bị tạm dừng quyền của một thành viên trong nhóm để quản lý các chìa khóa API nhóm:
- Thành viên được giao cho một vai trò khác mà không có quyền. Điều này có thể xảy ra khi chuyển quyền sở hữu nhóm.
- Quyền của thành viên đã bị tắt trên vai trò hiện tại của họ.
- Thành viên rời khỏi hoặc bị xóa khỏi nhóm.
- Tài khoản của thành viên đang bị kiểm soát bởi Roblox.
Trong bất kỳ trường hợp nào, những chìa khóa API được tạo bởi người dùng đó được cấp Huỷ trạng thái . Để sử dụng lại những chìa khóa này, chủ nhật nhóm hoặc thành viên với quyền Quản lý tất cả các chìa khóa API
Định dạng CIDR
Để bảo vệ tài nguyên của bạn, khi tạo một chìa khóa API, xác định địa chỉ IP có thể truy cập chìa khóa API bằng các địa chỉ IP bình thường hoặc bằng cách sử dụng <a href="https://developer.microsoft.com/en-us/microsoft-edge/ips">notación CIDR</a>. Một địa
- Bình thường : 192.168.0.0
- CIDR: : 192.168.0.0/24
Phần đầu tiên là địa chỉ IP và phần cuối cùng là net mask , đếm các bit của 1s trong dạng binh số. Trong ví dụ trước, 2
Tình trạng Chìa khóa API
Những chiave API ban đầu có một trạng thái chủ động, nhưng chúng có thể trở nên tạm dừng trong suốt cuộc sống của chúng. Để học tại sao một chiave API đã thay đổi trạng thái và làm thế nào để trả lại chiave API đến một trạng thái chủ động, hãy xem bảng sau đây.
Nếu bạn hoặc nhóm của bạn không sử dụng hoặc cập nhật một chiave API trong 60 ngày, nó sẽ tự động hết hạn, ngay cả khi nó không có ngày hết hạn cụ thể. Điều này giảm nguy cơ của các nhà tài trợ sử dụng các chiave API cũ. Nếu bạn khô
Tình trạng | Lý do | Độ phân giải |
---|---|---|
Hoạt động | Không có vấn đề. Người dùng có thể sử dụng chìa khóa để xác thực API. | Chưa có |
Vô hiệu hóa | Người dùng tắt chìa khóa bằng cách tắt nút Mở Chìa Khóa . | Kích hoạt nút Kích Hoạt Chìa KhóaToggle. |
Hết hạn | Ngày hết hạn của chìa khóa đã hết. | Loại bỏ hoặc đặt một ngày hết hạn mới. |
Tự động hết hạn | Người dùng chưa sử dụng hoặc cập nhật chìa khóa trong 60 ngày qua. | Bạn có thể bịt đó then enable the mở rộng chìa khóa toggle, hoặc bạn có thể cập nhật bất kỳ thuộc tính của chìa khóa, chẳng hạn như tên, miêu tảtả hoặc ngày hết hạn. |
Gạt bỏ | Chỉ dành cho chìa khóa nhóm. Tài khoản tạo ra chìa khóa này không còn có quyền truy cập đủ để quản lý chìa khóa của nhóm. | Nhấp vào Tạo một chìa khóa mới để lấy một chìa khóa mới. |
Đã điều chỉnh | Một quản trị viên Roblox đã thay đổi bí mật của chìa khóa vì lý do an ninh. | Nhấp vào Tạo một chìa khóa mới để lấy một chìa khóa mới. |
Người chơi đã được kiểm duyệt | Tài khoản mà đã tạo ra chìa khóa đang bị kiểm duyệt bởi Roblox. | Giải quyết vấn đề kiểm soát tài khoản. |