Registrar um Aplicativo GitHub

Sobre os registros do GitHub Apps

Você pode registrar o GitHub App na sua conta pessoal, na organização da qual você seja o proprietário ou na organização que concedeu a você permissão para gerenciar todos os aplicativos pertencentes à organização. Para obter mais informações, confira "Como adicionar e remover gerentes do Aplicativo do GitHub na sua organização".

Registrar o GitHub App

No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.
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.
Na barra lateral esquerda, clique em Configurações do desenvolvedor.
Na barra lateral esquerda, clique em GitHub Apps .
Clique em Novo Aplicativo do GitHub.
Em "Nome do GitHub App", insira um nome para seu aplicativo. Você deve escolher um nome distinto e curto. 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 no GitHub. Você não pode usar o mesmo nome de uma conta existente do GitHub, a menos que seja o seu nome de usuário ou de organização.
Opcionalmente, em "Descrição", digite uma descrição do aplicativo. Os usuários e as organizações verão essa descrição quando instalarem seu aplicativo.
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, então, você pode usar a URL da organização ou do usuário que é o proprietário do aplicativo.
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é dez URLs de retorno de chamada. 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 "Como gerar um token de acesso do usuário para um GitHub App".
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.
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 obter mais informações, confira "Autenticação com um aplicativo GitHub em nome de um usuário" e "Como gerar um token de acesso do usuário para um GitHub App."
Opcionalmente, se você quiser usar o fluxo do dispositivo para gerar um token de acesso do usuário, selecione Habilitar Fluxo de Dispositivo. Para obter mais informações, confira "Como gerar um token de acesso do usuário para um GitHub App".
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 obter mais informações, 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.
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.
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 obter mais informações, confira "Usar webhooks com aplicativos GitHub".
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 obter mais informações, confira "Usar webhooks com aplicativos GitHub".
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 obter mais informações, confira "Usar webhooks com aplicativos GitHub".
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.
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 obter mais informações, confira "Escolhendo permissões para um Aplicativo GitHub".
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".
Em "Em que local este GitHub App pode ser instalado?", selecione Somente nesta conta ou Qualquer conta. Para obter mais informações sobre as opções de instalação, confira "Tornar um aplicativo do GitHub público ou privado".
Clique em Criar Aplicativo do GitHub.

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:

Você deve ter como objetivo seguir as melhores práticas. Para obter mais informações, confira "Práticas recomendadas para criar um aplicativo do GitHub".

Depois que o GitHub App for totalmente criado, você poderá instalar o GitHub App e compartilhar o GitHub App com outras pessoas. Para obter mais informações, 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 obter mais informações, confira "Modificar um registro do Aplicativo GitHub".

Neste artigo

Sobre os registros do GitHub Apps

Registrar o GitHub App

Próximas etapas