Quản lý chìa khoá API

Mở Cloud xác minh và cho phép truy cập API bằng cách sử dụng chìa khóa API, cho phép bạn thêm các quyền cấp và kiểm soát an ninh cho việc truy cập và sử dụng các tài nguyên nhất định trong trải nghiệm của bạn, chẳng hạn như kho dữ liệu và nơi.

Tất cả API Mở đám mây đều yêu cầu bạn tạo một chìa khóa API có các quyền hạn hợp lệ và bao gồm một tiêu đề x-api-key trong yêu cầu của bạn, cho phép ứng dụng xác thực với Open Cloud thay mặt bạn.

Tạo chìa khoá API

Bạn có thể tạo và cấu hình chìa khóa API cho trải nghiệm riêng hoặc trải nghiệm thuộc sở hữu nhóm (một nhóm 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 sản và chia sẻ chìa khóa API).

Bạn phải là người sáng lập nhóm hoặc được gán vào một vai trò trong nhóm có quyền quản lý chìa khóa API để tạo chìa khóa API cho nhóm của bạn.Một thành viên nhóm chỉ có thể tạo một chìa khóa API với cùng quyền truy cập tài nguyên của vai trò của họ.Ví dụ, chỉ thành viên nhóm có quyền Tạo và chỉnh sửa trải nghiệm nhóm có thể tạo một chìa khóa API có thể xuất bản một tệp địa điểm.

Để tạo chìa khóa API:

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

2. (Tùy chọn) Click vào thùng thả Trung tâm Nhà sáng tạo để chọn một nhóm nếu bạn đang tạo chìa khóa API cho một nhóm.

3. Trong menu điều hướng bên trái, chọn Mở đám mây → Chìa khóa API .

4. Nhấp vào nút Tạo chìa khóa API .

5. Nhập một tên duy nhất cho chìa khóa API của bạn.Sử dụng một tên có thể giúp bạn ghi nhớ mục đích sau này, chẳng hạn như PLACE_PUBLISHING_KEY đối với các địa điểm xuất bản cho trải nghiệm của bạn.

6. Trong phần Quyền truy cập , 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.

7. Chọn trải nghiệm mà bạn muốn truy cập với chìa khóa API.

8. Từ menu thả xuống Hoạt động kinh nghiệm , chọn các hoạt động bạn muốn bật cho chìa khóa API.

   Nhiều hoạt động trong tham chiếu API bao gồm các phạm vi quyền cần thiết.Ví dụ, hoạt động thoát khỏi kho lưu trữ bộ nhớ yêu cầu quyền universe.memory-store:flush

   Vì lý do an ninh, hãy cung cấp cho mỗi chìa khóa API số lượng tối thiểu các quyền cần thiết.Nếu một chìa khóa API bị rò rỉ, nguyên tắc ít quyền nhất đảm bảo rằng chỉ một phần nhỏ của tài nguyên của bạn bị xâm phạm.

9. Trong phần Bảo mật , đặt rõ ràng truy cập IP vào chìa khóa bằng cách sử dụng biểu tượng CIDR, nếu không, bạn không thể sử dụng chìa khóa API.Bạn có thể tìm địa chỉ IP của máy địa phương của bạn và thêm nó vào phần Địa chỉ IP được chấp nhận cùng với các địa chỉ IP bổ sung cho những người cần truy cập.Nếu bạn không có IP cố định, hoặc bạn đang sử dụng chìa khóa API chỉ trong môi trường địa phương, bạn chỉ cần thêm 0.0.0.0/0 vào phần Địa chỉ IP được chấp nhận để cho phép bất kỳ IP nào sử dụng chìa khóa API của bạn.

10. (Tùy chọn) : Để thêm bảo vệ cho tài nguyên của bạn, hãy đặt ngày hết hạn rõ ràng để chìa khóa của bạn tự động ngừng hoạt động sau ngày đó.

11. Nhấp vào nút Lưu và Tạo chìa khóa .

12. Sao chép và lưu chuỗi khóa API ở một vị trí an toàn không phải là không một kho lưu trữ công cộng của mã của bạn.

13. Kiểm tra chìa khóa API được tạo của bạn trên trang Mở rộng API của Bảng điều khiển Nhà sáng tạo .

Quyền truy cập API thuộc sở hữu nhóm

Chủ nhóm có thể quản lý quyền truy cập API chính thức của nhóm cho các thành viên nhóm có các cấp độ kiểm soát khác nhau về API key dựa trên các vai trò và quyền trong nhóm .Cũng có những tình huống mà tự động thu hồi quyền quản lý chìa khóa API cho thành viên nhóm.

Cấp quyền cho phép

Với tư cách là người sáng lập 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 có quyền này có tất cả các quyền mà một chủ nhóm có cho API chìa khóa, bao gồm khả năng tạo, xem, chỉnh sửa, thu hồi và kiểm tra tất cả các chìa khóa API của nhóm.

Bạn cũng có thể cấp quyền Quản lý chìa khóa API riêng 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 thuộc về họ chứ không thể quản lý chìa khóa của người khác.

Xác nhận không hợp lệ quyền

Có nhiều tình huống mà tự động thu hồi quyền của thành viên nhóm để quản lý chìa khóa API nhóm:

• Thành viên được gán cho một vai trò khác không có quyền. Điều này có thể xảy ra trong quá trình chuyển giao sở hữu nhóm.
• Quyền của thành viên bị vô hiệu hóa trong vai trò hiện được gán cho họ.
• Thành viên rời hoặc bị xóa khỏi nhóm.
• Tài khoản của thành viên đang được kiểm duyệt bởi Roblox.

Trong bất kỳ trường hợp nào, chìa khóa API được tạo bởi người dùng đó được cung cấp tình trạng Bị thu hồi .Để sử dụng lại các chìa khóa này, người sáng lập nhóm hoặc thành viên có quyền Quản lý tất cả các chìa khóa API phải tạo lại các chìa khóa.

Định dạng CIDR

Để bảo vệ tài nguyên của bạn tiếp theo, khi tạo chìa khóa API, xác định địa chỉ IP có thể truy cập chìa khóa API bằng cách sử dụng địa chỉ IP bình thường hoặc sử dụng phép đánh dấu CIDR.Một địa chỉ IP CIDR trông giống như một địa chỉ IP bình thường ngoại trừ nó kết thúc bằng một dấu chia và một số thập phân đại diện cho số lượng bit của địa chỉ IP quan trọng cho việc chuyển hướng mạng:

• Thường : 192.168.0.0
• CIDR : 192.168.0.0/24

Phần trước là địa chỉ IP và phần sau là netmask , đếm các bit của 1s trong định dạng nhị phân.Trong ví dụ trước, 24 có nghĩa là 255.255.255.0 (24 1 giây) cho phép tất cả các IP giữa 192.168.0.0 và 192.168.0.255 .Hiểu định dạng CIDR là rất hữu ích nếu bạn dự định chạy ứng dụng của mình trên một máy chủ.

Tình trạng tháichìa khóa API

Vì vậy, các chìa khóa API ban đầu có tình trạng hoạt động, nhưng chúng có thể trở nên vô hiệu trong suốt cuộc sống của chúng.Để tìm hiểu lý do tại sao một chìa khóa API đã thay đổi trạng thái và cách trả lại chìa khóa API về trạng thái hoạt động, xem bảng sau.