docs/translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md

title, intro, redirect_from, versions, topics, shortTitle

title	intro	redirect_from	versions	topics	shortTitle
Criar um aplicativo GitHub usando parâmetros de URL	Você pode pré-selecionar as configurações de um novo {% data variables.product.prodname_github_app %} usando URL [parâmetros de consulta](https://en.wikipedia.org/wiki/Query_string) para definir rapidamente a configuração do novo {% data variables.product.prodname_github_app %}.	/apps/building-github-apps/creating-github-apps-using-url-parameters /developers/apps/creating-a-github-app-using-url-parameters	fpt ghes ghae ghec * * * *	GitHub Apps	Parâmetros de consulta de criação de aplicativo

Sobre parâmetros de URL do {% data variables.product.prodname_github_app %}.

Você pode adicionar parâmetros de consulta a essas URLs para pré-selecionar a configuração de um {% data variables.product.prodname_github_app %} em uma conta pessoal ou de organização:

• Personal account: {% data variables.product.oauth_host_code %}/settings/apps/new
• Conta da organização: {% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new

A pessoa que está criando o aplicativo pode editar os valores pré-selecionados a partir da página de registro do {% data variables.product.prodname_github_app %}, antes de enviar o aplicativo. Se você não incluir os parâmetros necessários na string de consulta da URL, como, por exemplo, o nome, a pessoa que criar o aplicativo deverá inserir um valor antes de enviar o aplicativo.

{% ifversion ghes > 3.1 or fpt or ghae or ghec %} Para aplicativos que exigem que um segredo proteja seu webhook, o valor do segredo deve ser definido no formulário pela pessoa que criou o aplicativo, não pelo uso de parâmetros de consulta. Para obter mais informações, consulte "Protegendo seus webhooks". {% endif %}

A URL a seguir cria um novo aplicativo pública denominado octocat-github-app com uma descrição pré-configurada e URL de chamada de retorno. Esta URL também seleciona permissões de leitura e gravação para verificações, inscreve-se nos eventos webhook de check_run e <code>check_suite e seleciona a opção de solicitar autorização do usuário (OAuth) durante a instalação:

{% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite

Lista completa de parâmetros de consulta, permissões e eventos disponíveis encontra-se nas seções abaixo.

Parâmetros de configuração do {% data variables.product.prodname_github_app %}

Nome	Tipo	Descrição
name	string	O nome do {% data variables.product.prodname_github_app %}. Dê um nome claro e sucinto ao seu aplicativo. Seu aplicativo não pode ter o mesmo nome de um usuário 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.
descrição	string	Uma descrição do {% data variables.product.prodname_github_app %}.
url	string	A URL completa da página inicial do site do seu {% data variables.product.prodname_github_app %}.
callback_urls	array de strigns	Uma URL completa para a qual redirecionar após alguém autorizar uma instalação. Você pode fornecer até 10 URLs de retorno de chamada. Essas URLs são usadas se o aplicativo precisar identificar e autorizar solicitações de usuário para servidor. Por exemplo, callback_urls[]=https://example.com&callback_urls[]=https://example-2.com.
request_oauth_on_install	boolean	Se seu aplicativo autoriza usuários a usar o fluxo OAuth, você poderá definir essa opção como verdadeiro para permitir que pessoas autorizem o aplicativo ao instalá-lo, economizando um passo. Se você selecionar esta opção, setup_url irá tornar-se indisponível e os usuários serão redirecionados para sua callback_url após instalar o aplicativo.
setup_url	string	A URL completa para redirecionamento após alguém instalar o {% data variables.product.prodname_github_app %}, se o aplicativo precisar de configuração adicional após a instalação.
setup_on_update	boolean	Defina como verdadeiro para redirecionar as pessoas para a URL de configuração quando as instalações forem atualizadas, por exemplo, após os repositórios serem adicionados ou removidos.
público	boolean	Defina verdadeiro quando seu {% data variables.product.prodname_github_app %} estiver disponível para o público ou como falso quando só for acessível pelo proprietário do aplicativo.
webhook_active	boolean	Defina como falso para desabilitar o webhook. O webhook está habilitado por padrão.
webhook_url	string	A URL completa para a qual você deseja enviar as cargas do evento de webhook.
{% ifversion ghes < 3.2 or ghae %}webhook_secret	string	Você pode especificar um segredo para proteger seus webhooks. Consulte "Protegendo seus webhooks" para obter mais detalhes.
{% endif %}events	array de strigns	Eventos webhook. Alguns eventos de webhook exigem permissões de leitura ou gravação para um recurso antes de poder selecionar o evento ao registrar um novo {% data variables.product.prodname_github_app %}, . Consulte a seção "{% data variables.product.prodname_github_app %} eventos de webhook" para eventos disponíveis e suas permissões necessárias. Você pode selecionar vários eventos em uma string de consulta. Por exemplo, eventos[]=public&eventos[]=label.{% ifversion ghes < 3.4 %}
domínio	string	A URL de uma referência de conteúdo.{% endif %}
single_file_name	string	Esta é uma permissão de escopo limitado que permite que o aplicativo acesse um único arquivo em qualquer repositório. Quando você define a permissão single_file para read ou write, este campo fornece o caminho para o único arquivo que o {% data variables.product.prodname_github_app %} gerenciará. {% ifversion fpt or ghes or ghec %} Se você precisar gerenciar vários arquivos, veja single_file_paths abaixo. {% endif %}{% ifversion fpt or ghes or ghec %}
single_file_paths	array de strigns	Isso permite que o aplicativo acesse até dez arquivos especificados em um repositório. Quando você define a permissão single_file para read ou write, este array pode armazenar os caminhos de até dez arquivos que seu {% data variables.product.prodname_github_app %} gerenciará. Todos esses arquivos recebem a mesma permissão definida por single_file, e não têm permissões individuais separadas. Quando dois ou mais arquivos estão configurados, a API retorna multiple_single_files=true, caso contrário retorna multiple_single_files=false.{% endif %}

Permissões do {% data variables.product.prodname_github_app %}

Você pode selecionar permissões em uma string de consultas usando o nome da permissão na tabela a seguir como o nome do parâmetro de consulta e o tipo de permissão como valor da consulta. Por exemplo, para selecionar permissões de Leitura & gravação na interface de usuário para conteúdo, sua string de consulta incluiria &contents=write. Para selecionar as permissões Somente leitura na interface de usuário para bloquear, sua string de consulta incluiria &blocking=read. Para selecionar sem acesso na interface do usuário para verificações, sua string de consulta não incluiria a permissão verificações.

Permissão	Descrição
administração	Concede acesso a vários pontos finais para administração de organização e repositório. Pode ser: nenhum, leitura ou gravação.{% ifversion fpt or ghec %}
bloqueio	Concede acesso à API de usuários de bloqueio. Pode ser: nenhum, leitura ou gravação.{% endif %}
Verificações	Concede acesso à API de verificação. Pode ser: nenhum, leitura ou gravação.{% ifversion ghes < 3.4 %}
content_references	Concede acesso ao ponto final "Criar um anexo de conteúdo. Pode ser: nenhum, leitura ou gravação.{% endif %}
Conteúdo	Concede acesso a vários pontos finais que permitem modificar o conteúdo do repositório. Pode ser: nenhum, leitura ou gravação.
Implantações	Concede acesso à API de implementação. Pode ser: nenhum, leitura ou gravação.{% ifversion fpt or ghes or ghec %}
emails	Concede acesso à API de e-mails. Pode ser: nenhum, leitura ou gravação.{% endif %}
seguidores	Concede acesso à API de seguidores. Pode ser: nenhum, leitura ou gravação.
gpg_keys	Concede acesso à API de chaves de GPG. Pode ser: nenhum, leitura ou gravação.
Problemas	Concede acesso à API de problemas. Pode ser: nenhum, leitura ou gravação.
chaves	Concede acesso à API de chaves públicas. Pode ser: nenhum, leitura ou gravação.
members	Concede acesso para gerenciar os membros de uma organização. Pode ser: nenhum, leitura ou gravação.{% ifversion fpt or ghec %}
metadados	Concede acesso a pontos finais somente leitura que não vazam dados confidenciais. Pode ser leitura ou nenhum. O padrão é leitura, ao definir qualquer permissão, ou nenhum quando você não especificar nenhuma permissão para o {% data variables.product.prodname_github_app %}.
organization_administration	Concede acesso ao ponto final "Atualizar uma organização" ponto final e Pa API de restrições de interação da organização. Pode ser: nenhum, leitura ou gravação.{% endif %}
organization_hooks	Concede acesso à API de webhooks da organização. Pode ser: nenhum, leitura ou gravação.
organization_plan	Concede acesso para obter informações sobre o plano de uma organização usando o ponto final "Obter uma organização". Pode ser: nenhum ou leitura.
organization_projects	Concede acesso à API de Projetos. Pode ser: nenhum, leitura, gravação ou administrador.{% ifversion fpt or ghec %}
organization_user_blocking	Concede acesso à API de usuários de bloqueio da organização. Pode ser: nenhum, leitura ou gravação.{% endif %}
Páginas	Concede acesso à API de páginas. Pode ser: nenhum, leitura ou gravação.
plano	Concede acesso para obter informações sobre o plano de um usuário do GitHub que usa o ponto final "Obter um usuário". Pode ser: nenhum ou leitura.
pull_requests	Concede acesso a vários pontos finais do pull request. Pode ser: nenhum, leitura ou gravação.
repository_hooks	Concede acesso à API de webhooks do repositório. Pode ser: nenhum, leitura ou gravação.
repository_projects	Concede acesso à API de Projetos. Pode ser: nenhum, leitura, gravação ou administrador.{% ifversion ghes or ghec %}
secret_scanning_alerts	Concede acesso à API de varredura de segredo. Pode ser: none, read ou write.{% endif %}{% ifversion fpt or ghes or ghec %}
security_events	Concede acesso à API de varredura de código. Pode ser: nenhum, leitura ou gravação.{% endif %}
single_file	Concede acesso à API de conteúdo. Pode ser: nenhum, leitura ou gravação.
estrela	Concede acesso à API estrelada. Pode ser: nenhum, leitura ou gravação.
Status	Concede acesso à API de status. Pode ser: nenhum, leitura ou gravação.
team_discussions	Concede acesso à API de discussões de equipe e à API de comentários de discussão de equipe. Pode ser: nenhum, leitura ou gravação.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
vulnerability_alerts	Concede acesso para receber {% data variables.product.prodname_dependabot_alerts %} para dependências vulneráveis em um repositório. Consulte "Sobre {% data variables.product.prodname_dependabot_alerts %}" para saber mais. Pode ser: none ou read.{% endif %}
inspecionando	Concede acesso à lista e alterações de repositórios que um usuário assinou. Pode ser: nenhum, leitura ou gravação.

Eventos webhook do {% data variables.product.prodname_github_app %}

Nome do evento webhook	Permissão necessária	Descrição
check_run	Verificações	{% data reusables.webhooks.check_run_short_desc %}
check_suite	Verificações	{% data reusables.webhooks.check_suite_short_desc %}
commit_comment	Conteúdo	{% data reusables.webhooks.commit_comment_short_desc %}{% ifversion ghes < 3.4 %}
content_reference	content_references	{% data reusables.webhooks.content_reference_short_desc %}{% endif %}
create	Conteúdo	{% data reusables.webhooks.create_short_desc %}
delete	Conteúdo	{% data reusables.webhooks.delete_short_desc %}
implantação	Implantações	{% data reusables.webhooks.deployment_short_desc %}
implantação_status	Implantações	{% data reusables.webhooks.deployment_status_short_desc %}
bifurcação	Conteúdo	{% data reusables.webhooks.fork_short_desc %}
gollum	Conteúdo	{% data reusables.webhooks.gollum_short_desc %}
Problemas	Problemas	{% data reusables.webhooks.issues_short_desc %}
issue_comment	Problemas	{% data reusables.webhooks.issue_comment_short_desc %}
etiqueta	metadados	{% data reusables.webhooks.label_short_desc %}
integrante	members	{% data reusables.webhooks.member_short_desc %}
filiação	members	{% data reusables.webhooks.membership_short_desc %}
marco	pull_request	{% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %}
org_block	organization_administration	{% data reusables.webhooks.org_block_short_desc %}{% endif %}
organização	members	{% data reusables.webhooks.organization_short_desc %}
page_build	Páginas	{% data reusables.webhooks.page_build_short_desc %}
project	repository_projects ou organization_projects	{% data reusables.webhooks.project_short_desc %}
project_card	repository_projects ou organization_projects	{% data reusables.webhooks.project_card_short_desc %}
project_column	repository_projects ou organization_projects	{% data reusables.webhooks.project_column_short_desc %}
público	metadados	{% data reusables.webhooks.public_short_desc %}
pull_request	pull_requests	{% data reusables.webhooks.pull_request_short_desc %}
pull_request_review	pull_request	{% data reusables.webhooks.pull_request_review_short_desc %}
pull_request_review_comment	pull_request	{% data reusables.webhooks.pull_request_review_comment_short_desc %}
pull_request_review_thread	pull_request	{% data reusables.webhooks.pull_request_review_thread_short_desc %}
push	Conteúdo	{% data reusables.webhooks.push_short_desc %}
versão	Conteúdo	{% data reusables.webhooks.release_short_desc %}
repositório	metadados	{% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %}
repository_dispatch	Conteúdo	Permite aos integradores que usam o GitHub Actions acionar eventos personalizados.{% endif %}
status	Status	{% data reusables.webhooks.status_short_desc %}
equipe	members	{% data reusables.webhooks.team_short_desc %}
team_add	members	{% data reusables.webhooks.team_add_short_desc %}
inspecionar	metadados	{% data reusables.webhooks.watch_short_desc %}