註冊您的 OAuth 2.0 應用程序可以讓它存取 Roblox 資源。 在註冊後,Roblox 會為應用程序分配獨一無二的客戶ID和秘密,讓您可以使用它來從用戶那裡獲得授權來存取他們的 Roblox 資訊和資源。
註冊您的應用程序
要註冊應用程App:
- 在 創作者控制板 中,前往 OAuth 2.0 應用程式 頁面。
- 點擊 創建 OAuth 2.0 應用程式 按鈕。
- 輸入一個有效且全球獨一無二的 應用名稱 。
- 閱讀並同意 Roblox 服務條款 ,然後按一下 創建 。
- 複製並存儲 客戶端 ID 和 秘密 在安全位空間。關閉頁面後,你不再擁有存取秘密的權限,只能生成新的。在註冊完畢一個應用程式後,你仍可以存取並編輯其他App式的其他屬性。
- 按一下 繼續編輯 以設定您的App用程序,這是在下一個部分中說明的。
設定一般資訊
你註冊了自己的應用程App後,你應該設定其一般資訊,包括:
- 一個說明,讓 Roblox 社群的每個人都能看到。
- 為您的App用程式的縮略圖像。建議的檔案大小為至少 150x150 像素。
- 作為您的App用程序入口點的 入口鏈接 ,例如 app 的網站首頁。
- 隱私條款網址 和 服務條款網址 對終端使用者可以閱讀,以便授權您的App用。每個網址必須是 HTTPS,並且不超過 256 個字符。
新增許可
為了確保在您的App中正確的存取控制和安全,您必須添加 權限範圍 。有兩種類型的權限範圍可用:
- 身份範圍 用於認證,例如 openid 用於用戶ID 和 profile 用於完整個人檔案。如果您選擇 0> profile0> 範圍,您必須也選擇 3> openid 3>。
- API 特定權限範圍 ,例如 asset:read 對資產的閱取權限。選擇您需要的最小範圍。
添加重新定向 URL
重新導航網址 是您的應用程序使用者完成授權您的應用程App後重新導入的點。確保您的重新導航網址符合以下要求:
- 所有重新導向網址必須在下列任何一個形式中:
- 例如: https://www.example.com 。
- 路徑在本地主機上使用 HTTP 或 HTTPS (自簽證書) 以便本地Debug,例如:
- http://localhost:80
- https://localhost:80
- 為特定應用或目的而設計的自訂方案,例如:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- 重新向 URL 的最大長度是 256 個字元。
- 您可以添加最多 10 個重新導航網址。 有多個重新導航網址,您可以有測試環境,允許用戶在兩個網站之間無時間間隔地移動。
提交評論
為了最小限度地降低惡意應用對社群造成傷害的機會,註冊應用程式並不使其公開提供。 相反,它在 私人模式 中,最多只能容納 100 位受權用戶。此模式對於測試和調查在您的團隊中很有幫助。
如果您想要為您的應用程App擴展用戶基礎,您需要將它提交至公開模式,以便進行審核:
- 前往OAuth 2.0 Apps頁面。
- 點擊 編輯和發佈 按鈕為您想要發佈的應用程序。
- 填寫所有必要信息,然後按一下 查看和發佈 按鈕。顯示您在等待審查期間對應的應用權限限制的訊息。
- 點擊 提交評論 。
在您的應用程式檢查尚未完成之前,您不能編輯或提交另一個請求。您的應用程式仍在私人模式中,直到您的審核查請求被批准或拒絕。當您的應用程式被批准時,它將切換為公開模式,並且您將無法將它返回到私人模式。
無論您的應用程序是否被批准或拒絕,您都會收到結論完成時的電子郵件通知。
編輯和刪除您的應用程序
如果您的應用程序未審核,您可以使用以下步驟編輯或刪除它:
前往OAuth 2.0 Apps頁面。
點擊 編輯 或 刪除 以對應應用程App。
- 如果您選擇編輯應用程App,請遵循 註冊 的步驟和要求。
- 如果您選擇刪除應用程App,請按一下 是的,刪除 來確認刪除。在你刪除應用程App後,你就無法取回它。
修改您的App用程序的一般信息或重新導航網址不需要使用者重新授權應用程App。 但如果您添加或修改權限範圍,您必須獲得您的用戶的授權,並從您的用戶那裡取得新的權限。 如果您沒有獲得權限範圍,您的應用程序可以繼續使用已有的代幣,但是受到以前的範圍限制。
對於私人模式的應用程式,系統會自動更新您的編輯與您的用戶。對於公開模式的應用程式,您必須再次提交應用程式以反映這些變更。否則,系統會儲存未發佈的變更,而不會發佈給社群。