跳至主要内容

关于设置 URL

您可以指定一个 URL,用户在安装 GitHub 应用后将重定向到该 URL。

注册 GitHub 应用时,您可以指定一个设置 URL。当用户安装您的 GitHub 应用时,他们会被重定向到设置 URL。如果安装后需要进行其他设置,您可以使用此 URL 告诉用户下一步需要执行哪些步骤。

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

警告

当 GitHub 将用户重定向到设置 URL 时,它会包含一个installation_id查询参数。恶意行为者可以使用伪造的installation_id访问此 URL。因此,您不应依赖installation_id参数的有效性。相反,您应该为安装 GitHub 应用的用户生成一个用户访问令牌,然后检查该安装是否与该用户关联。有关更多信息,请参阅“为 GitHub 应用生成用户访问令牌”。

尽管设置 URL 在 GitHub 应用注册期间是可选的,但如果您希望允许用户在 GitHub Marketplace 中购买您的应用,则它是必需的。有关更多信息,请参阅“处理新购买和免费试用”。

设置 URL 与回调 URL 不同。用户在安装 GitHub 应用后会被重定向到设置 URL。用户通过 Web 应用程序流程授权 GitHub 应用时会被重定向到回调 URL。有关更多信息,请参阅“关于用户授权回调 URL”。

有关注册 GitHub 应用的更多信息,请参阅“注册 GitHub 应用”。有关修改 GitHub 应用注册的更多信息,请参阅“修改 GitHub 应用注册”。