Skip to main content

Criar um aplicativo GitHub

Você pode criar e registrar um aplicativo GitHub na sua conta pessoal em sob qualquer organização à qual você tem acesso administrativo.

Para saber como usar os Manifestos de Aplicativo do GitHub, que permitem que as pessoas criem Aplicativos do GitHub pré-configurados, confira "Como criar Aplicativos do GitHub com base en um manifesto".

Observação: Um usuário ou uma organização pode ser o proprietário de até 100 Aplicativos do GitHub.

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

    • Para um GitHub App pertencente a uma conta pessoal, no canto superior direito de qualquer página, clique na foto do seu perfil e clique em Configurações. Ícone Settings (Configurações) na barra de usuário
    • Para um GitHub App pertencente a uma organização, no canto superior direito de qualquer página, clique na foto do seu perfil e clique em Suas organizações. Em seguida, à direita da organização, clique em Configurações. Suas organizações no menu do perfil O botão de configurações
  2. In the left sidebar, click Developer settings.

  3. Na barra lateral esquerda, clique em Aplicativos do GitHub. Seção Aplicativos do GitHub

  4. Clique em Novo Aplicativo do GitHub. Botão usado para criar um Aplicativo do GitHub

  5. Em "Nome do aplicativo GitHub App", digite o nome do seu aplicativo. Campo do nome do Aplicativo do GitHub

    Dê um nome claro e sucinto ao seu aplicativo. Seu aplicativo não pode ter o mesmo nome de uma conta existente no GitHub, a menos que seja o seu próprio nome de usuário ou da sua organização. Uma versão movida do nome do seu aplicativo será exibida na interface do usuário quando sua integração realizar uma ação.

  6. Opcionalmente, em "Descrição", digite uma descrição do aplicativo que os usuários irão ver. Campo de descrição do Aplicativo do GitHub

  7. Em "URL da página inicial", digite a URL completa do site do seu aplicativo. Campo da URL da home page do Aplicativo do GitHub

  8. Em "URL de retorno de chamada", digite a URL completa para redirecionar após um usuário autorizar a instalação. Esta URL é usada se o aplicativo precisar identificar e autorizar solicitações de usuário para servidor.

    Use Adicionar URL de retorno de chamada para fornecer, até, no máximo, dez URLs de retorno de chamada adicionais.

    Botão 'Adicionar URL de retorno de chamada' e campo usado para URL de retorno de chamada

  9. Por padrão, para melhorar a segurança de seus aplicativos, seus aplicativos usarão os tokens de autorização do usuário. Para optar por não usar tokens do usuário expirados, você deverá desmarcar "Expirar tokens de autorização do usuário". Para saber mais sobre como configurar um fluxo de token de atualização e os benefícios dos tokens de usuário com validade, confira "Como atualizar tokens de acesso de usuário para servidor". Opção usada para aceitar os tokens de usuários com validade durante a configuração de Aplicativos do GitHub

  10. Se o aplicativo autorizar os usuários que usam o fluxo OAuth, você poderá selecionar Solicitar autorização do usuário (OAuth) durante a instalação para permitir que as pessoas autorizem o aplicativo quando o instalam, economizando uma etapa. Se você selecionar esta opção, a "URL de configuração" irá tornar-se indisponível e os usuários serão redirecionados para a "URL de retorno de chamada de autorização do usuário" após a instalação do aplicativo. Confira "Como autorizar usuários durante a instalação" para obter mais informações. Solicitar a autorização do usuário durante a instalação

  11. Se o Aplicativo do GitHub usar o fluxo do dispositivo para identificar e autorizar os usuários, clique em Habilitar Fluxo do Dispositivo. Para obter mais informações sobre o fluxo do dispositivo, confira "Como autorizar Aplicativos OAuth". Captura de tela que mostra o campo usado para habilitar o fluxo do dispositivo

  12. Se for necessária uma configuração adicional após a instalação, adicione um "Configurar URL" para redirecionar os usuários após a instalação do seu aplicativo. Campo usado para a URL de configuração do Aplicativo do GitHub

    Observação: quando você seleciona Solicitar autorização do usuário (OAuth) durante a instalação na etapa anterior, esse campo fica indisponível e as pessoas são redirecionadas para a "URL de retorno de chamada de autorização do usuário" após a instalação do aplicativo.

  13. Na "URL Webhook", digite a URL para a qual os eventos serão POST. Cada aplicativo recebe o seu próprio webhook, que irá notificá-lo sempre que o aplicativo for instalado ou modificado, bem como quaisquer outros eventos que o aplicativo assinar. Campo usado para a URL do webhook do Aplicativo do GitHub

  14. Opcionalmente, no "Segredo do webhook", digite um token secreto opcional usado para proteger seus webhooks. Campo usado para adicionar um token secreto para seu webhook

    Observação: recomendamos expressamente que você defina um token secreto. Para obter mais informações, confira "Como proteger seus webhooks".

  15. Em "Permissões", escolha as permissões que o seu aplicativo irá solicitar. Para cada tipo de permissão, use o menu suspenso e clique em Somente leitura, Leitura e gravação ou Sem acesso. Várias permissões para Aplicativo do GitHub

  16. Em "Assinar eventos", escolha os eventos que você deseja que seu aplicativo receba.

  17. Para escolher o local de instalação do aplicativo, selecione Somente nesta conta ou Qualquer conta. Para obter mais informações sobre as opções de instalação, confira "Como tornar um Aplicativo do GitHub público ou privado". Opções de instalação do Aplicativo do GitHub

  18. Clique em Criar Aplicativo do GitHub. Botão usado para criar o Aplicativo do GitHub