註冊您的 OAuth 2.0 應用程式可讓它存取 Roblox 資源。註冊後,Roblox 會為應用程式分配一個獨特的客戶端 ID 和秘密,您可以使用它來從使用者那裡獲得授權,以存取他們的 Roblox 資訊和資源。
註冊您的應用程App
要註冊應用程App:
- 在 創作者面板 中,前往 OAuth 2.0 應用 頁面。
- 按一下 創建OAuth 2.0應用程式 按鈕。
- 輸入一個有效且全球獨一的 應用名稱 。
- 閱讀並同意 Roblox 服務條款 ,然後點擊 創建 。
- 複製並儲存 客戶端ID 和 秘密 在安全的空間方。關閉頁面後,您將無法再使用秘密,只能生成新的秘密。完成註冊應用程App後,您仍可存取和編輯應用程App的其他屬性。
- 點擊 繼續編輯 來配置您的應用程App,這在下一個部分中被描述。
配置一般資訊
一旦您註冊了您的應用程App,您應該配置其一般資訊,包括:
- 對所有 Roblox 社群成員可見的說明。
- 您應用程App的縮略圖像。建議的文件尺寸至少為 150x150 像素。
- 一個 入口鏈接 作為您應用程App的入口點,例如應用程App的網站首頁。
- 一個 隱私條款網址 和一個 服務條款網址 供用戶在授權您的應用程App之前閱讀。每個URL必須是HTTPS且不超過256個字元。
新增許可
為了在App用程式內確保適當的存取控制和安全性,您必須新增 權限範圍 。有兩種類型的許可範圍可用:
- 身份範圍 用於驗證,例如openid和profile。如果您選擇 profile 範圍,您也必須選擇 openid 。
- API 特定權限範圍 ,例如 asset:read 對資產的閱讀權限。只選擇您App用程式需要的最少數量的範圍。
新增重定向 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
- 重定向網址的最大長度為 256 個字元。
- 您可以添加最多 10 個重定向 URL。使用多個重定向 URL,您可以擁有測試環境並允許用戶在兩個網站之間無中斷地進行轉換。
提交審核
為了減少惡意應用對社群造成傷害的機會,註冊應用程式不會使其廣泛可用。相反,它仍然在 私人模式 中,並受到限制為 10 個獨特使用者。此模式對於在您的團隊中進行測試和偵錯有幫助。
如果您想擴展應用程App的使用者基礎,您需要透過提交以進行審核論來發布它於公共模式:
- 前往 OAuth 2.0 應用 頁面。
- 點擊 編輯和發布 按鈕以發布您想要發佈的應用程序。
- 填寫所有必要資訊,然後點擊 審核和發布 按鈕。期待審查期間的應用權限限制的訊息出現。
- 點擊 提交審核 。
當您的應用程式審查待定時,您無法編輯或提交另一個請求,直到現有審查請求被批准或拒絕為止。在審核期間,您的應用程式仍保持私人模式。當您的應用程式獲得批准時,它會切換到公共模式,您無法將其恢復到私人模式。
無論您的應用程式是否獲得批准或拒絕,當審查完成時,您都會收到電子郵件通知結果。
編輯和刪除您的應用程App
如果它未在審核中,您可以使用以下步驟編輯或刪除應用程式:
前往 OAuth 2.0 應用 頁面。
點擊 編輯 或 刪除 以獲得所需的App用程序。
- 如果您選擇編輯應用程App,請遵循註冊的相同步驟和要求。
- 如果您選擇刪除應用程App,請單擊 是,刪除 以確認刪除。刪除應用程App後,無法恢復。
修改應用程App的一般資訊或重定向URL不需要使用者重新授權應用程App。但是,如果您增加或修改許可範圍,您必須從使用者那裡獲得新許可的授權並獲得一組新的代幣。如果您未獲得新範圍的授權,您的應用程式可以繼續使用現有的代幣,但僅限於以前的範圍。
對於私人模式的應用程式,系統會自動與使用者更新您的編輯。對於公共模式的應用程式,您必須再次提交應用程式進行審查,以反映這些變更。否則,系統會為您保存尚未發布的變更,而不會將其發布給社群。