註冊您的 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(自簽名證書)路徑,用於本地調試目的,例如:
- 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 應用程式 頁面。
- 點擊您想要發布的應用程式的 編輯和發布 按鈕。
- 填寫所有必填資訊,包括演示視頻和描述,然後點擊 審核和發布 按鈕。會顯示一條消息,告知您在待審核期間應用程式權限的限制。
- 點擊 提交審核。
提交所需的以下資訊:
- 一個公共 演示視頻 連結,長度不超過 1 分鐘,並符合以下要求:
- 以用戶登出開始,並顯示觸發 OAuth 同意對話框的確切用戶操作,例如點擊 使用 Roblox 登入。視頻必須顯示整個授權流程,通過重定向回到您的應用程式,包括重定向後您原始應用程式中的內容。
- 顯示您在提交中提供的相同註冊詳細資訊。
- 一個解釋為什麼您的應用程式屬於所選類別以及它如何使用請求的權限範圍的理由。
在您的應用程式審核待處理期間,您無法編輯或提交另一個請求,直到當前的審核請求獲得批准或被拒絕。您的應用程式在審核期間保持在私有模式。當您的應用程式獲得批准時,它會轉換為公共模式,您無法將其恢復為私有模式。
無論您的應用程式是獲得批准還是被拒絕,當審核完成時,您都會收到結果的電子郵件通知。
編輯和刪除您的應用程式
如果您的應用程式未在審核中,您可以按照以下步驟編輯或刪除它:
轉到 OAuth 2.0 應用程式 頁面。
點擊所需應用程式的 編輯 或 刪除。
- 如果您選擇編輯應用程式,請遵循 註冊 的相同步驟和要求。
- 如果您選擇刪除應用程式,請點擊 是,刪除 以確認刪除。刪除應用程式後,您無法恢復它。
修改應用程式的一般資訊或重定向 URL 不需要用戶重新授權應用程式。然而,如果您添加或修改權限範圍,則必須從用戶那裡獲得新權限的授權並獲取一組新的令牌。如果您未獲得新範圍的授權,您的應用程式可以繼續使用現有的令牌,但僅限於之前的範圍。
對於私有模式的應用程式,系統會自動將您的編輯更新到您的用戶。對於公共模式的應用程式,您必須再次 提交應用程式以進行審核 以反映這些更改。否則,系統會為您保存未發布的更改,而不會將其釋放給社區。