Ao registrar o GitHub App, você pode especificar uma URL de instalação. Quando os usuários instalam seus dados do GitHub App, eles são redirecionados para a URL de instalação. Se uma instalação adicional for necessária após a instalação, use essa URL para informar os usuários sobre as próximas etapas que devem ser seguidas.
Se você especificar uma URL de instalação, também poderá selecionar Redirecionar na atualização para especificar que os usuários devem ser redirecionados para a URL de instalação após atualizarem uma instalação. Uma atualização inclui a adição ou a remoção de acesso a um repositório para uma instalação.
Warning
Quando o GitHub redireciona os usuários para a URL de instalação, ele inclui um parâmetro de consulta installation_id
. Atores ruins podem atingir essa URL com um installation_id
falsificado. Portanto, você não deve confiar na validade do parâmetro installation_id
. Em vez disso, você deve gerar um token de acesso do usuário para o usuário que instalou o GitHub App e verificar se a instalação está associada a esse usuário. Para saber mais, confira Como gerar um token de acesso do usuário para um GitHub App.
Embora a URL de instalação seja opcional durante o registro do GitHub App, ela será necessária se você quiser permitir que os usuários comprem seu aplicativo em GitHub Marketplace. Para saber mais, confira Gerenciar novas compras e testes grátis.
A URL de instalação é diferente da URL de retorno de chamada. Os usuários são redirecionados para a URL de instalação depois de instalarem um GitHub App. Os usuários são redirecionados à URL de retorno de chamada quando autorizam um GitHub App por meio do fluxo do aplicativo Web. Para saber mais, confira Sobre a URL de retorno de chamada de autorização do usuário.
Para obter mais informações sobre como registrar o GitHub App, confira Registrar um Aplicativo GitHub. Para obter mais informações sobre como modificar um registro do GitHub App, confira Modificar um registro do Aplicativo GitHub.