Việc đăng ký ứng dụng OAuth 2.0 của bạn cho phép nó truy cập vào các tài nguyên của Roblox. Sau khi đăng ký, Roblox sẽ gán cho ứng dụng một ID khách hàng và bí mật duy nhất mà bạn có thể sử dụng để lấy quyền truy cập từ người dùng để truy cập thông tin và tài nguyên Roblox của họ.
Đăng ký ứng dụng của bạn
Để đăng ký một ứng dụng:
- Trong Bảng điều khiển Người sáng tạo, đi đến trang Ứng dụng OAuth 2.0.
- Nhấp vào nút Tạo ứng dụng.
- Nhập một Tên ứng dụng hợp lệ và duy nhất toàn cầu.
- Đọc và đồng ý với Điều khoản dịch vụ của Roblox và nhấp vào Tạo.
- Sao chép và lưu trữ ID khách hàng và Bí mật ở một nơi an toàn. Sau khi đóng trang, bạn sẽ không còn quyền truy cập vào bí mật và chỉ có thể tạo một cái mới. Sau khi bạn hoàn tất việc đăng ký một ứng dụng, bạn vẫn có thể truy cập và chỉnh sửa các thuộc tính khác của ứng dụng.
- Nhấp vào Tiếp tục chỉnh sửa để cấu hình ứng dụng của bạn, điều này sẽ được mô tả trong các phần tiếp theo.
Cấu hình thông tin chung
Khi bạn đã đăng ký ứng dụng của mình, bạn nên cấu hình thông tin chung của nó, bao gồm:
- Một mô tả, mà mọi người trong cộng đồng Roblox đều có thể thấy.
- Một hình ảnh thu nhỏ cho ứng dụng của bạn. Kích thước tệp được khuyến nghị là ít nhất 150x150 pixel.
- Một Liên kết vào như là điểm vào của ứng dụng của bạn, chẳng hạn như trang web chính của ứng dụng.
- Một URL Điều khoản quyền riêng tư và một URL Điều khoản dịch vụ để người dùng cuối đọc trước khi ủy quyền cho ứng dụng của bạn. Mỗi URL phải là HTTPS và không quá 256 ký tự.
Thêm quyền
Để đảm bảo kiểm soát truy cập và bảo mật đúng cách trong ứng dụng của bạn, bạn phải thêm Phạm vi quyền. Có hai loại phạm vi quyền có sẵn:
- Phạm vi danh tính cho xác thực, chẳng hạn như openid cho ID người dùng và profile cho các hồ sơ đầy đủ. Nếu bạn chọn phạm vi profile, bạn cũng phải chọn openid.
- Phạm vi quyền cụ thể API, chẳng hạn như asset:read cho quyền đọc tài sản. Chọn chỉ số lượng phạm vi tối thiểu mà bạn cần cho ứng dụng của mình.
Thêm URL chuyển hướng
URL chuyển hướng là các điểm vào lại của ứng dụng của bạn mà người dùng được chuyển hướng đến khi họ hoàn tất việc ủy quyền cho ứng dụng của bạn. Đảm bảo rằng các URL chuyển hướng của bạn đáp ứng các yêu cầu sau:
- Tất cả các URL chuyển hướng phải ở một trong các dạng sau:
- HTTPS thuần túy, ví dụ: https://www.example.com.`
- Đường dẫn trên localhost với HTTP hoặc HTTPS (chứng chỉ tự ký) cho mục đích gỡ lỗi cục bộ, ví dụ:
- http://localhost:80
- https://localhost:80
- Các sơ đồ tùy chỉnh cho các ứng dụng hoặc mục đích cụ thể, ví dụ:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- Độ dài tối đa của một URL chuyển hướng là 256 ký tự.
- Bạn có thể thêm tối đa 10 URL chuyển hướng. Với nhiều URL chuyển hướng, bạn có thể có các môi trường thử nghiệm và cho phép người dùng di chuyển giữa hai trang mà không bị gián đoạn.
Gửi để xem xét
Để giảm thiểu khả năng các ứng dụng độc hại gây hại cho cộng đồng, việc đăng ký một ứng dụng không làm cho nó có thể truy cập rộng rãi. Thay vào đó, nó vẫn ở chế độ riêng tư với giới hạn 10 người dùng duy nhất. Chế độ này hữu ích cho việc thử nghiệm và gỡ lỗi trong nhóm của bạn.
Nếu bạn muốn mở rộng cơ sở người dùng cho ứng dụng của mình, bạn cần xuất bản nó ở chế độ công khai bằng cách gửi nó để xem xét:
- Đi đến trang Ứng dụng OAuth 2.0.
- Nhấp vào nút Chỉnh sửa và Xuất bản cho ứng dụng mà bạn muốn xuất bản.
- Điền vào tất cả thông tin cần thiết, bao gồm video demo và mô tả, sau đó nhấp vào nút Xem xét và Xuất bản. Một thông báo với giới hạn về quyền của ứng dụng bạn trong thời gian xem xét đang chờ xử lý sẽ xuất hiện.
- Nhấp vào Gửi để xem xét.
Thông tin sau là cần thiết cho việc gửi của bạn:
- Một liên kết Video Demo công khai không dài hơn 1 phút và đáp ứng các yêu cầu sau:
- Bắt đầu với người dùng đã đăng xuất và hiển thị hành động chính xác của người dùng, chẳng hạn như nhấp vào Đăng nhập với Roblox, để kích hoạt hộp thoại đồng ý OAuth. Video phải hiển thị toàn bộ quy trình ủy quyền thông qua việc chuyển hướng trở lại ứng dụng của bạn, bao gồm nội dung trong ứng dụng gốc của bạn sau khi chuyển hướng.
- Hiển thị cùng các chi tiết đăng ký mà bạn cung cấp với việc gửi của bạn.
- Một lý do giải thích tại sao ứng dụng của bạn thuộc về danh mục đã chọn và cách nó sử dụng các phạm vi quyền đã yêu cầu.
Trong khi yêu cầu xem xét ứng dụng của bạn đang chờ xử lý, bạn không thể chỉnh sửa hoặc gửi yêu cầu khác cho đến khi yêu cầu xem xét hiện tại được phê duyệt hoặc từ chối. Ứng dụng của bạn vẫn ở chế độ riêng tư trong quá trình xem xét. Khi ứng dụng của bạn được phê duyệt, nó sẽ chuyển sang chế độ công khai, và bạn không thể quay lại chế độ riêng tư.
Bất kể ứng dụng của bạn được phê duyệt hay từ chối, bạn sẽ nhận được thông báo qua email về kết quả khi việc xem xét hoàn tất.
Chỉnh sửa và xóa ứng dụng của bạn
Bạn có thể chỉnh sửa hoặc xóa ứng dụng của mình với các bước sau nếu nó không đang trong quá trình xem xét:
Đi đến trang Ứng dụng OAuth 2.0.
Nhấp vào Chỉnh sửa hoặc Xóa cho ứng dụng mong muốn.
- Nếu bạn chọn chỉnh sửa một ứng dụng, hãy làm theo các bước và yêu cầu tương tự như đăng ký.
- Nếu bạn chọn xóa một ứng dụng, hãy nhấp vào Có, Xóa để xác nhận việc xóa. Sau khi bạn xóa một ứng dụng, bạn không thể khôi phục nó.
Việc sửa đổi thông tin chung của ứng dụng hoặc các URL chuyển hướng không yêu cầu người dùng phải ủy quyền lại cho ứng dụng. Tuy nhiên, nếu bạn thêm hoặc sửa đổi các phạm vi quyền, bạn phải lấy quyền ủy quyền cho các quyền mới từ người dùng của mình và có được một bộ mã thông báo mới. Nếu bạn không lấy được quyền ủy quyền cho các phạm vi mới, ứng dụng của bạn có thể tiếp tục sử dụng các mã thông báo hiện có, nhưng bị giới hạn ở các phạm vi trước đó.
Đối với các ứng dụng ở chế độ riêng tư, hệ thống tự động cập nhật các chỉnh sửa của bạn với người dùng của bạn. Đối với các ứng dụng ở chế độ công khai, bạn phải gửi ứng dụng để xem xét lại để phản ánh những thay đổi này. Nếu không, hệ thống sẽ lưu các thay đổi chưa xuất bản cho bạn mà không phát hành nó cho cộng đồng.