Skip to main content

关于设置 URL

可以指定用户在安装 GitHub App 后将被重定向到的 URL。

注册 GitHub App 时,可指定设置 URL。 当用户安装 GitHub App 后,他们将被重定向到设置 URL。 如果安装后需要其他设置,可以使用此 URL 告知用户接下来要执行的步骤。

如果指定设置 URL,还可以选择“更新时重定向”,以指定用户更新安装后应被重定向到设置 URL。 更新包括针对安装添加或删除存储库访问权限。

警告:当 GitHub 将用户重定向到设置 URL 时,它会包含一个 installation_id 查询参数。 恶意操作者可以使用欺骗性 installation_id 点击此 URL。 因此,不应依赖于 installation_id 参数的有效性。 相反,应为安装 GitHub App 的用户生成用户访问令牌,然后检查安装是否与该用户相关联。 有关详细信息,请参阅“为 GitHub 应用生成用户访问令牌”。

虽然设置 URL 在 GitHub App 注册期间是可选的,但如果要允许用户在 GitHub Marketplace 中购买你的应用,则需要设置该 URL。 有关详细信息,请参阅“处理新购买和免费试用”。

设置 URL 与回叫 URL 不同。 用户安装 GitHub App 后,系统会将他们重定向到设置 URL。 当用户通过 Web 应用程序流授权 GitHub App 后,系统会将他们重定向到回叫 URL。 有关详细信息,请参阅“关于用户授权回调 URL”。

若要详细了解如何注册 GitHub App,请参阅“注册 GitHub 应用”。 若要详细了解如何修改 GitHub App 注册,请参阅“修改 GitHub 应用注册”。