注册您的 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 不需要用户重新授权应用。但是,如果您添加或修改权限范围,您必须从用户那里获得新权限的授权,并获取一组新的令牌。如果您未获得新范围的授权,您的应用可以继续使用现有令牌,但仅限于之前的范围。
对于处于私有模式的应用,系统会自动将您的编辑更新到用户。对于处于公共模式的应用,您必须再次 提交应用审核 以反映这些更改。否则,系统会为您保存未发布的更改,而不会将其发布给社区。