Registrando um aplicativo GitHub

Sobre os registros do GitHub Apps

Você pode registrar um GitHub App de algumas maneiras diferentes.

• Na sua conta pessoal.
• Em uma organização de que você é proprietário.
• Em uma organização que lhe concedeu permissão para gerenciar todos os seus aplicativos. Confira Adicionando e removendo gerenciadores do aplicativo GitHub em sua organização.
• Em sua empresa, mas só pode ser instalado naquela empresa e organizações dentro daquela empresa.

Um usuário, organização ou empresa pode registrar até 100 GitHub Apps, mas não há limite para quantos GitHub Apps podem ser instalados em uma conta.

Registrar o GitHub App

1. No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.

2. Acesse as configurações da sua conta.

   • Para um aplicativo de propriedade de uma conta pessoal, clique em Configurações.
   • Para um aplicativo de propriedade de uma organização:
     1. Clique em Suas organizações.
     2. À direita da organização, clique em Configurações.
   • Para um aplicativo de propriedade de uma empresa:
     1. Se você usar Enterprise Managed Users, clique em Sua empresa para ir diretamente para as configurações da conta corporativa.
     2. Se você usar contas pessoais, clique em Suas empresas e, à direita da empresa, clique em Configurações.

3. Navegue até as configurações GitHub App.

   • Para um aplicativo pertencente a uma conta pessoal ou a uma organização:
     1. Na barra lateral esquerda, clique em Developer settings e clique em GitHub Apps.
   • Para um aplicativo de propriedade de uma empresa:
     1. Na barra lateral esquerda, em "Configurações", clique em GitHub Apps.

4. Clique em Novo GitHub App.

5. Em "GitHub App name", insira um nome para o aplicativo. Você deve escolher um nome distinto e curto. O nome não pode ter mais de 34 caracteres. O nome do aplicativo (convertido em minúsculas, com espaços substituídos por - e com caracteres especiais substituídos) será mostrado na interface do usuário quando o aplicativo executar uma ação. Por exemplo, My APp Näme será exibido como my-app-name.

   O nome precisa ser exclusivo em GitHub. Você não pode usar o mesmo nome de uma conta existente da GitHub, a menos que seja o seu nome de usuário ou de organização.

6. Opcionalmente, em "Descrição", digite uma descrição do aplicativo. Os usuários verão essa descrição quando instalarem seu aplicativo.

7. Em "URL da página inicial", digite a URL completa do site do seu aplicativo. Se você não tiver uma URL dedicada e o código do aplicativo estiver armazenado em um repositório público, use essa URL do repositório. Ou você pode usar a URL da conta que detém o aplicativo.

8. Em "URL de retorno de chamada", digite a URL completa para redirecionamento após um usuário autorizar a instalação.

   Você pode especificar até 10 URLs de callback. Para adicionar outras URLs de retorno de chamada, clique em Adicionar URL de retorno de chamada.

   Se o aplicativo não precisar atuar em nome de um usuário (não precisa gerar um token de acesso do usuário), esse campo será ignorado. Se o aplicativo usar o fluxo do dispositivo em vez do fluxo do aplicativo Web para gerar um token de acesso do usuário, esse campo será ignorado.

   Para obter mais informações sobre a URL de retorno de chamada, confira Sobre a URL de retorno de chamada de autorização do usuário. Para obter mais informações sobre como gerar um token de acesso do usuário para atuar em nome de um usuário, confira Autenticação com um aplicativo GitHub em nome de um usuário e Gerando um token de acesso do usuário para um aplicativo GitHub.

9. Opcionalmente, para impedir que os tokens de acesso do usuário expirem, desmarque Expirar tokens de autorização do usuário. O GitHub recomenda fortemente que você mantenha essa opção selecionada. Para obter mais informações sobre como atualizar tokens expirados e os benefícios dos tokens de acesso do usuário que expiram, confira Atualizar tokens de acesso do usuário. Se o aplicativo não precisar gerar um token de acesso do usuário, esse campo será ignorado.

10. Opcionalmente, para solicitar que os usuários autorizem seu aplicativo ao instalá-lo, selecione Solicitar autorização do usuário (OAuth) durante a instalação. Se um usuário autorizar seu aplicativo, o aplicativo poderá gerar um token de acesso do usuário para fazer solicitações de API em nome do usuário e atribuir a atividade do aplicativo ao usuário. Para saber mais, confira Autenticação com um aplicativo GitHub em nome de um usuário e Gerando um token de acesso do usuário para um aplicativo GitHub.

11. Opcionalmente, se você quiser usar o fluxo do dispositivo para gerar um token de acesso do usuário, selecione Habilitar Fluxo de Dispositivo. Para saber mais, confira Gerando um token de acesso do usuário para um aplicativo GitHub.

12. Opcionalmente, em "URL de Instalação", insira a URL para a qual os usuários serão redirecionados após a instalação do aplicativo. Se uma instalação adicional for necessária após a instalação, use essa URL para informar os usuários sobre as etapas que devem ser seguidas após a instalação. Para saber mais, confira Sobre a URL de instalação.

    Se você selecionou Solicitar autorização de usuário (OAuth) durante a instalação em uma etapa anterior, não é possível inserir uma URL aqui. Em vez disso, os usuários serão redirecionados para a URL de retorno de chamada como parte do fluxo de autorização, no qual você poderá descrever a configuração adicional.

13. Opcionalmente, se você quiser redirecionar os usuários para a URL de instalação depois que eles atualizarem uma instalação, selecione Redirecionar após atualização. Uma atualização inclui a adição ou a remoção de um repositório para uma instalação. Se a opção "URL de Instalação" estiver em branco, isso será ignorado.

14. Opcionalmente, se você não quiser que o aplicativo receba eventos de webhook, desmarque Ativo. Por exemplo, se o aplicativo só será usado para autenticação ou não precisar responder aos webhooks, desmarque essa opção. Para saber mais, confira Usando webhooks com aplicativos GitHub.

15. Se você selecionou Ativo na etapa anterior, em "URL do webhook", insira a URL para a qual o GitHub deve enviar os eventos de webhook. Para saber mais, confira Usando webhooks com aplicativos GitHub.

16. Opcionalmente, se você selecionou Ativo na etapa anterior, em "Segredo do webhook", insira um token secreto para proteger seus webhooks. O GitHub recomenda fortemente que você defina um segredo de webhook. Para saber mais, confira Usando webhooks com aplicativos GitHub.

17. Se você inseriu uma URL de webhook, em "Verificação de SSL", selecione se deseja habilitar a verificação de SSL. O GitHub recomenda fortemente que você habilite a verificação de SSL.

18. Em "Permissões", escolha as permissões de que o aplicativo precisará. Para cada permissão, selecione o menu suspenso e clique em Somente leitura, Leitura e gravação ou Sem acesso. Você deve selecionar as permissões mínimas necessárias para seu aplicativo. Para saber mais, confira Escolhendo permissões para um aplicativo GitHub.

19. Se você selecionou Ativo na etapa anterior para indicar que seu aplicativo deve receber eventos de webhook, em "Assinar eventos", selecione os eventos de webhook que deseja que o aplicativo receba. As permissões selecionadas na etapa anterior determinam os eventos de webhook que estão disponíveis. Para obter mais informações sobre cada evento de webhook, confira Eventos e cargas de webhook.

20. Em "Onde este GitHub App pode ser instalado?", selecione Somente nesta conta ou Qualquer conta. Se você usar Enterprise Managed Users, Somente nesta conta será desabilitado para contas de usuário. Em vez de Qualquer conta, a opção lerá Esta empresa. Para obter mais informações sobre as opções de instalação, confira Tornando um aplicativo GitHub público ou privado.

    Observação

    Se o GitHub App estiver registrado em uma empresa, essa etapa não se aplica.

21. Clique em Criar GitHub App.

Próximas etapas

Depois de registrar o GitHub App, você desejará escrever código para fazer com que o GitHub App faça algo. Para obter exemplos de como escrever código, confira:

•         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/quickstart)
  

•         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)
  

•         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)
  

•         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)
  

•         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)
  

Você deve ter como objetivo seguir as melhores práticas. Para saber mais, confira Práticas recomendadas para criar um aplicativo GitHub.

Assim que o GitHub App estiver completamente desenvolvido, você poderá instalar o GitHub App e compartilhar o GitHub App com outras pessoas. Para saber mais, confira Instalando seu próprio aplicativo GitHub e Compartilhando seu Aplicativo GitHub.

Você sempre pode fazer alterações nas configurações do seu GitHub App. Para saber mais, confira Modificando um registro de aplicativo GitHub.