注册您的 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用的网站主页。
- 一个 隐私条款URL 和一个 服务条款URL 供用户阅读,以授权您的App用。每个 URL 必须是 HTTPS 且不超过 256 个字符。
添加权限
为了确保您应用程App内的正确访问控制和安全,您必须添加 权限范围 。有两种类型的权限范围可用:
- 身份范围 用于验证,例如用户ID的openid和全面个人资料的profile。如果您选择 profile 范围,您还必须选择 openid 。
- API 特定权限范围 ,例如 asset:read 对资产的阅读权限。选择仅需要您应用程App的最低数量的范围。
添加重定向 URL
重定向 URL 是用户在完成授权您的应用时重定向到的应App重新入口点。确保您的重定向 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 个独特用户。该模式对于在您的团队中进行测试和调试有帮助。
如果您想扩展App用的用户基础,您需要通过提交进行审阅核将其发布为公共模式:
- 前往 OAuth 2.0 应用 页面。
- 点击 编辑和发布 按钮为您想要发布的应用程序。
- 填写所有必填信息,然后单击 审核和发布 按钮。在待定审核期间,出现具有限制您应用权限的消息。
- 点击 提交审核 。
在您的应用评审等待定期间,您无法编辑或提交另一个请求,直到当前评审请求被批准或拒绝为止。在审阅审期间,您的应用仍处于私有模式。当您的应用被批准时,它将切换到公共模式,您无法将其恢复到私有模式。
无论您的应用是否被批准或拒绝,完成审查后,您都会收到一封电子邮件通知结果。
编辑和删除您的应App
如果它不在审阅中,您可以通过以下步骤编辑或删除您的应用程序:
前往 OAuth 2.0 应用 页面。
单击 编辑 或 删除 以获取所需的App用程序。
- 如果您选择编辑应用程App,请遵循注册的相同步骤和要求。
- 如果你选择删除应用程App,点击 是,删除 确认删除。删除应用程App后,无法恢复。
修改应App的一般信息或重定向 URL 不需要用户重新授权应App。但是,如果您添加或修改权限范围,您必须获得用户对新权限的授权并获得新一组代币。如果您未获得新范围的授权,您的应用程序仍可继续使用现有代币,但仅限于以前的范围。
对于私有模式的应用程序,系统自动向您的用户更新编辑内容。对于公共模式的应用程序,您必须再次提交应用程序进行审查,以反映这些更改。否则,系统会保存未发布的更改,而不会向社区发布它们。