注册您的 OAuth 2.0 应用程序可以让它访问 Roblox 资源。 在注册后,Roblox 为应用程序分配唯一的客户端 ID 和秘密,您可以使用它来从用户那里获得授权以访问他们的 Roblox 信息和资源。
注册您的应用程序
要注册应用程App:
- 在创建者仪表板中,前往OAuth 2.0 应用页面。
- 点击 创建 OAuth 2.0 应用 按钮。
- 输入一个有效且独特的 应用名称 。
- 阅读并同意 Roblox 服务条款 ,然后单击 创建 。
- 复制并存储 客户端ID 和 秘密 在安全位场景。关闭页面后,您不再拥有访问秘密的权限,只能生成新的。在注册应用程App完成后,您仍然可以访问并编辑应用程App的其他属性。
- 单击 继续编辑 以配置您的App用程序,这在下面的部分中描述。
配置通用信息
一旦您 注册 您的应用程App,您应该配置其一般信息,包括:
- 描述,对 Roblox 社区的每个人都可见。
- 您应用程App的缩略图图像。 建议的文件大小为至少 150x150 像素。
- 作为您的应用的入口,例如App的应用的App站首页。
- 隐私条款 URL 和 服务条款 URL 用于用户端在授权您的App用之前阅读。每个 URL 都必须是 HTTPS 且不超过 256 个字符。
添加权限
为了在您的App中确保有效的访问控制和安全,您必须添加 权限范围 。有两种类型的权限范围可用:
- 身份范围 用于认证,例如 openid 用户 ID 和 profile 完整 profil。如果您选择 0> 个人资料rofile0> 范围,您还必须选择 3> openid 3>。
- API 权限范围 ,例如 asset:read 对资产的读取权限。选择您需要的最小范围。
添加红色网址
重新定向 URL 是您的应用程序的重新入口点,用户会在他们完成授权您的应用程App后转到。请确保您的重新定向 URL 满足以下要求:
- 所有重置 URL 都必须在以下形式之一:
- 例如,为了 Plain HTTPS: https://www.example.com .
- 使用 HTTP 或 HTTPS (自签证书) 在本地host上的路径,例如:
- 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 可以有测试环境,允许用户在两个网站之间无需关闭。
提交于评论
为了最大限度地降低恶意应用程序对社区造成伤害的可能性,注册一个应用程序不会将其公开提供。 相反,它仍然保留在 私人模式 ,其限制为 100 个授权用户。 此模式有助于在您的团队测试和调试。
如果您想要为您的App用扩展用户基础,您需要将其发布为公开模式,通过提交它进行审阅:
- 前往OAuth 2.0 应用页面。
- 点击您想要发布的应用程序的 编辑和发布 按钮。
- 填写所有必填信息,然后单击 查看和发布 按钮。一个带有限制您 app 权限在待评论期间的消息出现。
- 点击 提交评论 。
在您的应用程序评论正在待定时,您不能编辑或提交其他请求,直到当前评论请求被批准或拒绝。您的应用程序仍然处于私人模式,在审阅论期间您无法返回私人模式。当您的应用程序被批准时,它将切换到公共模式,您无法将其返回到私人模式。
无论您的应用是否被批准或拒绝,您都会收到评论完成后的电子邮件通知。
编辑和删除您的应用
如果您的应用程序不在审阅论中,您可以使用以下步骤编辑或删除它:
前往OAuth 2.0 应用页面。
单击 编辑 或 删除 以便为所需的应用程序。
- 如果您选择编辑应用程App,请按照注册的相同步骤和要求进行。
- 如果您选择删除应用程App,单击 是的,删除 确认删除。在您删除应用程App后,您无法恢复它。
修改您的App用程序的一般信息或重新定向 URL 不需要用户重新授权应用程App。 但如果您添加或修改权限范围,您必须获得您的用户的授权,并从新权限中获得新的代币。 如果您未获得新的范围的授权,您的应用程序可以继续使用现有代币,但是受到以前的范围的限制。
对于私下模式的应用,系统会自动将您的编辑与您的用户更新。 对于公开模式的应用,您必须再次提交应用程序进行评论,以反映这些更改。 否则,系统会为您保留未发布的更改。