註冊您的 OAuth 2.0 應用程式使其能夠訪問 Roblox 資源。註冊後,Roblox 會為應用程式分配一個唯一的客戶端 ID 和密鑰,您可以使用這些來獲得用戶的授權,以訪問他們的 Roblox 資訊和資源。
註冊您的應用程式
要註冊應用程式:
- 在 創作者儀表板 中,轉到 OAuth 2.0 應用程式 頁面。
- 點擊 創建應用 按鈕。
- 輸入有效且全球唯一的 應用名稱。
- 閱讀並同意 Roblox 服務條款,然後點擊 創建。
- 複製並將 客戶端 ID 和 密鑰 存儲在安全的地方。在關閉頁面後,您將無法再訪問密鑰,只能生成新的。註冊應用程式後,您仍然可以訪問和編輯應用程式的其他屬性。
- 點擊 繼續編輯 來配置您的應用,詳細內容如下節中描述。
配置一般資訊
註冊完您的應用後,您應該配置其一般資訊,包括:
- 描述,對 Roblox 社區中的每個人可見。
- 應用的縮略圖圖像。建議的檔案尺寸至少為 150x150 像素。
- 作為應用入口點的 入口鏈接,例如應用的網站首頁。
- 供最終用戶在授權您應用之前閱讀的 隱私條款 URL 和 服務條款 URL。每個 URL 必須是 HTTPS 並且不超過 256 個字符。
添加權限
為了確保您應用的正確訪問控制和安全性,您必須添加 權限範圍。有兩種類型的權限範圍可用:
- 用於身份驗證的 身份範圍,例如 openid 用於用戶 ID 和 profile 用於完整的個人資料。如果您選擇 profile 範圍,您還必須選擇 openid。
- 針對 API 的特定權限範圍,例如 asset:read 用於資產的讀取許可。僅選擇您應用所需的最小範圍。
添加重定向 URL
重定向 URL 是用戶完成授權您的應用後返回的進入點。確保您的重定向 URL 符合以下要求:
- 所有重定向 URL 必須採用以下形式之一:
- 普通的 HTTPS,例如:https://www.example.com.
- HTTP 或 HTTPS(自簽名證書)上的 localhost 路徑,用於當地調試,例:
- http://localhost:80
- https://localhost:80
- 用於特定應用程序或目的的自定義方案,例如:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- 重定向 URL 的最大長度為 256 個字符。
- 您可以添加最多 10 個重定向 URL。擁有多個重定向 URL,您可以擁有測試環境,並允許用戶在兩個站點之間遷移而不會有停機時間。
提交審查
為了最小化惡意應用對社區造成傷害的機會,註冊應用程式並不會使其廣泛可用。相反,它保持在 私密模式,並限制為 10 位唯一用戶。此模式對於團隊內的測試和除錯非常有用。
如果您想擴展應用的用戶基礎,您需要通過提交審查將其發佈到公共模式:
- 轉到 OAuth 2.0 應用程式 頁面。
- 點擊您要發佈的應用的 編輯並發佈 按鈕。
- 填寫所有必填信息,然後點擊 審查並發佈 按鈕。顯示一條有關您應用在等待審查期間的許可限制的消息。
- 點擊 提交審查。
在您的應用審查等待期間,您無法編輯或提交另一個請求,直到當前的審查請求獲得批准或被拒絕。在審查期間,您的應用保持在私密模式。一旦您的應用獲得批准,它將轉換為公共模式,您無法將其恢復為私密模式。
無論您的應用是獲得批准還是被拒絕,審查完成後,您會收到結果的電子郵件通知。
編輯和刪除應用
如果您的應用未在審查中,您可以按照以下步驟編輯或刪除它:
轉到 OAuth 2.0 應用程式 頁面。
點擊所需應用的 編輯 或 刪除。
- 如果選擇編輯應用,請遵循 註冊 的相同步驟和要求。
- 如果選擇刪除應用,點擊 是,刪除 以確認刪除。在刪除應用後,您無法恢復它。
修改應用的一般資訊或重定向 URL 不需要用戶重新授權應用。然而,如果您添加或修改權限範圍,您必須從用戶那裡獲得對新權限的授權並獲取一組新的令牌。如果您未獲得對新範圍的授權,您的應用可繼續使用現有令牌,但僅限於以前的範圍。
對於私密模式中的應用,系統會自動用您的編輯更新用戶。對於公共模式中的應用,您必須再次 提交應用以供審查 以反映這些更改。否則,系統會為您保存未發佈的更改,而不會將其釋放給社區。