1
0
mirror of synced 2026-01-26 03:06:48 -05:00
Files
docs/translations/es-ES/content/developers/apps/creating-a-github-app-using-url-parameters.md
Vanessa Yuen 5336b9a35c translations batch (#17637)
* New Crowdin translations by Github Action

* fix frontmatter errors in translation

* fix release notes

* revert broken translation to main

Co-authored-by: Crowdin Bot <support+bot@crowdin.com>
2021-02-02 19:56:26 +00:00

34 KiB

title, intro, redirect_from, versions
title intro redirect_from versions
Crear una GitHub App utilizando parámetros de URL Puedes preseleccionar los ajustes de una nueva {% data variables.product.prodname_github_app %} utilizando [parámetros de consulta] de una URL (https://en.wikipedia.org/wiki/Query_string) para configurar rápidamente los nuevos ajustes de la {% data variables.product.prodname_github_app %}.
/apps/building-github-apps/creating-github-apps-using-url-parameters
free-pro-team enterprise-server github-ae
* * *

Acerca de los parámetros de URL de las {% data variables.product.prodname_github_app %}

Puedes agregar parámetros de consulta a estas URL para preseleccionar la configuración de una {% data variables.product.prodname_github_app %} en una cuenta organizacional o personal:

  • Cuenta de usuario: {% data variables.product.oauth_host_code %}/settings/apps/new
  • Cuenta de organización: {% data variables.product.oauth_host_code %}/:org/settings/apps/new

El creador de la app puede editar los valores preseleccionados desde la página de registro de la {% data variables.product.prodname_github_app %} antes de emitirla. Si no incluyes los parámetros requeridos en la secuencia de consulta de la URL, como el name, el creador de la app necesitará ingresar un valor antes de emitirla.

La siguiente URL crea una app pública nueva que se llama octocat-github-app con una descripción preconfigurada y una URL de rellamado. Esta URL también selecciona los permisos de lectura y escritura para las checks, se suscribe a los eventos de webhook de check_run y check_suite, y selecciona la opción para solicitar la autorización del usuario (OAuth) durante la instalación:

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

La lista completa de parámetros de consulta, permisos y eventos disponibles se lista en las secciones siguientes.

Parámetros de configuración de una {% data variables.product.prodname_github_app %}

Nombre Type Descripción
name (nombre) secuencia El nombre de la {% data variables.product.prodname_github_app %}. Pónle un nombre claro y breve a tu app. Tu app no puede tener el mismo nombre que un usuario de GitHub, a menos de que sea tu propio nombre de usuario u organización. Una versión simplificada del nombre de tu aplicación se mostrará en la interface de usuario cuando tu integración tome alguna acción.
descripción secuencia Una descripción de la {% data variables.product.prodname_github_app %}.
url secuencia La URL complea de la página principal del sitio web de tu {% data variables.product.prodname_github_app %}.
callback_url secuencia La URL completa a la cual se redirigirá después de que alguien autorice la instalación. Esta URL se utiliza si tu app necesita identificar y autorizar las solicitudes de usuario a servidor.
request_oauth_on_install boolean Si tu app autoriza a los usuarios mediante el flujo de OAuth, puedes configurar esta opción como true para permitir que las personas autoricen la app cuando la instalen, lo cual te ahorra un paso. Si seleccionas esta opción, la setup_url deja de estar disponible y se redirigirá a los usuarios a tu callback_url después de que instalen la app.
setup_url secuencia La URL completa a la cual se redirigirá después de que instalen la {% data variables.product.prodname_github_app %} si ésta requiere de alguna configuración adicional después de su instalación.
setup_on_update boolean Configúralo como true para redireccionar a las personas a la URL de ajustes cuando las instalaciones se actualicen, por ejemplo, después de que se agreguen o eliminen repositorios.
public boolean Configúralo como true cuando tu {% data variables.product.prodname_github_app %} se encuentre disponible al público, o como false cuando solo el propietario de la misma tenga acceso a ella.
webhook_url secuencia La URL completa a la cual quisieras enviar cargas útiles de eventos de webhook.
webhook_secret secuencia Puedes especificar un secreto para asegurar tus webhooks. Consulta la sección "Asegurar tus webhooks" para obtener más detalles.
events conjunto de secuencias Eventos de webhook. Algunos eventos de webhook requieren asignar permisos de read o de write a un recurso antes de que puedas seleccionar el evento cuando registras una {% data variables.product.prodname_github_app %} nueva. Consulta la sección "Eventos de webhook de las {% data variables.product.prodname_github_app %}" para encontrar los eventos disponibles y sus permisos requeridos. Puedes seleccionar eventos múltiples en una secuencia de consulta. Por ejemplo, events[]=public&events[]=label.
dominio secuencia La URL de una referencia de contenido.
single_file_name secuencia Este es un permiso con alcance corto que permite a la app acceder a un solo archivo en cualquier repositorio. Cuando configuras el permiso de single_file en read o write, este campo proporciona la ruta al archivo único que administrará tu {% data variables.product.prodname_github_app %}. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} Si necesitas administrar varios archivos, consulta la opción single_file_paths a continuación. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
single_file_paths conjunto de secuencias Esto permite a la app acceder hasta a 10 archivos especificos en un repositorio. Cuando configuras el permiso single_file en read o write, este arreglo puede almacenar las rutas de hasta diez archivos que administrará tu {% data variables.product.prodname_github_app %}. Estos archivos reciben el mismo permiso que se configuró para single_file, y no tienen permisos individuales por separado. Cuando dos o mas archivos se configuran, la API devuelve multiple_single_files=true, de lo contrario, devuelve multiple_single_files=false.{% endif %}

Permisos de la {% data variables.product.prodname_github_app %}

Puedes seleccionar los permisos en una secuencia de consulta utilizando los nombres de permiso conforme en la siguiente tabla a manera de nombres de parámetro de consulta y usando el tipo de permiso como el valor de la consulta. Por ejemplo, para seleccionar los permisos de Read & write en la interface de usuario para contents, tu secuencia de consulta incluiría &contents=write. Para seleccionar los permisos de Read-only en la interface de usuario para blocking, tu secuencia de consulta incluiría &blocking=read. Para seleccionar no-access en la interface de usuario para las checks, tu secuencia de consulta no incluiría el permiso checks.

Permiso Descripción
administration Otorga acceso a diversas terminales para la administración de organizaciones y repositorios. Puede ser uno de entre: none, read, o write.{% if currentVersion == "free-pro-team@latest" %}
blocking Otorga acceso a la API de Bloqueo de Usuarios. Puede ser uno de entre none, read, o write.{% endif %}
verificaciones Otorga acceso a la API de verificaciones. Puede ser uno de entre none, read, o write.
content_references Otorga acceso a la terminal "Crear un adjunto de contenido". Puede ser uno de entre none, read, o write.
contenidos Otorga acceso a diversas terminales que te permiten modificar el contenido de los repositorios. Puede ser uno de entre none, read, o write.
implementaciones Otorga acceso a la API de despliegues. Puede ser uno de entre: none, read, o write.{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
emails Otorga acceso a la API de Correos electrónicos. Puede ser uno de entre none, read, o write.{% endif %}
followers Otorga acceso a la API de Seguidores. Puede ser uno de entre none, read, o write.
gpg_keys Otorga acceso a la API de Llaves GPG. Puede ser uno de entre none, read, o write.
propuestas Otorga acceso a la API de Informe de problemas. Puede ser uno de entre none, read, o write.
keys Otorga acceso a la API de Llaves Públicas. Puede ser uno de entre none, read, o write.
members Otorga acceso para administrar los miembros de una organización. Puede ser uno de entre: none, read, o write.{% if currentVersion == "free-pro-team@latest" %}
metadatos Otorga acceso a las terminales de solo lectura que no filtran datos sensibles. Puede ser read o none. Su valor predeterminado es read cuando configuras cualquier permiso, o bien, none cuando no especificas ningún permiso para la {% data variables.product.prodname_github_app %}.
organization_administration Otorga acceso a la terminal "Actualizar una organización" y a la API de Restricciones de Interacción en la Organización. Puede ser uno de entre none, read, o write.{% endif %}
organization_hooks Otorga acceso a la API de Webhooks de la Organización. Puede ser uno de entre none, read, o write.
organization_plan Otorga acceso para obtener información acerca del plan de una organización que utilice la terminal "Obtener una organización". Puede ser uno de entre none o read.
organization_projects Otorga acceso a la API de Proyectos. Puede ser uno de entre: none, read, write, o admin.{% if currentVersion == "free-pro-team@latest" %}
organization_user_blocking Otorga acceso a la API de Bloqueo de Usuarios de la Organización. Puede ser uno de entre none, read, o write.{% endif %}
páginas Otorga acceso a la API de páginas. Puede ser uno de entre none, read, o write.
plan Otorga acceso para obtener información acerca del plan de GitHub de un usuario que utilice la terminal "Obtener un usuario". Puede ser uno de entre none o read.
pull_requests Otorga acceso a varias terminales de solicitud de extracción. Puede ser uno de entre none, read, o write.
repository_hooks Otorga acceso a la API de Webhooks del Repositorio. Puede ser uno de entre none, read, o write.
repository_projects Otorga acceso a la API de Proyectos. Puede ser uno de entre: none, read, write, o admin.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
secret_scanning_alerts Otorga acceso a la API de escaneo de secretos. Puede ser uno de entre: none, read, o write.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
security_events Otorga acceso a la API de escaneo de código. Puede ser uno de entre none, read, o write.{% endif %}
single_file Otorga acceso a la API de Contenidos. Puede ser uno de entre none, read, o write.
starring Otorga acceso a la API de marcar con estrella. Puede ser uno de entre none, read, o write.
estados Otorga acceso a la API de Estados. Puede ser uno de entre none, read, o write.
team_discussions Otorga acceso a la API de debates de equipo y a la API de comentarios en debates de equipo. Puede ser uno de entre: none, read, o write.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@1.19" %}
vulnerability_alerts Otorga acceso para recibir alertas de seguridad para las dependencias vulnerables en un repositorio. Consulta la sección "Acerca de las alertas de seguridad para las dependencias vulnerables" para aprender más. Puede ser uno de entre: none o read.{% endif %}
observando Otorga acceso a la lista y cambia los repositorios a los que un usuario está suscrito. Puede ser uno de entre none, read, o write.

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

Nombre del evento de webhook Permiso requerido Descripción
check_run verificaciones {% data reusables.webhooks.check_run_short_desc %}
check_suite verificaciones {% data reusables.webhooks.check_suite_short_desc %}
comentario_confirmación de cambios contenidos {% data reusables.webhooks.commit_comment_short_desc %}
content_reference content_references {% data reusables.webhooks.content_reference_short_desc %}
create (crear) contenidos {% data reusables.webhooks.create_short_desc %}
delete contenidos {% data reusables.webhooks.delete_short_desc %}
deployment implementaciones {% data reusables.webhooks.deployment_short_desc %}
deployment_status implementaciones {% data reusables.webhooks.deployment_status_short_desc %}
bifurcación contenidos {% data reusables.webhooks.fork_short_desc %}
gollum contenidos {% data reusables.webhooks.gollum_short_desc %}
propuestas propuestas {% data reusables.webhooks.issues_short_desc %}
comentario_propuesta propuestas {% data reusables.webhooks.issue_comment_short_desc %}
etiqueta metadatos {% data reusables.webhooks.label_short_desc %}
miembro members {% data reusables.webhooks.member_short_desc %}
membership members {% data reusables.webhooks.membership_short_desc %}
hito solicitud_extracción {% data reusables.webhooks.milestone_short_desc %}{% if currentVersion == "free-pro-team@latest" %}
org_block organization_administration {% data reusables.webhooks.org_block_short_desc %}{% endif %}
organization members {% data reusables.webhooks.organization_short_desc %}
page_build páginas {% data reusables.webhooks.page_build_short_desc %}
project repository_projects u organization_projects {% data reusables.webhooks.project_short_desc %}
project_card repository_projects u organization_projects {% data reusables.webhooks.project_card_short_desc %}
project_column repository_projects u organization_projects {% data reusables.webhooks.project_column_short_desc %}
public metadatos {% data reusables.webhooks.public_short_desc %}
solicitud_extracción pull_requests {% data reusables.webhooks.pull_request_short_desc %}
revisión_solicitud de extracción solicitud_extracción {% data reusables.webhooks.pull_request_review_short_desc %}
comentarios _revisiones_solicitudes de extracción solicitud_extracción {% data reusables.webhooks.pull_request_review_comment_short_desc %}
subir contenidos {% data reusables.webhooks.push_short_desc %}
lanzamiento contenidos {% data reusables.webhooks.release_short_desc %}
repositorio metadatos {% data reusables.webhooks.repository_short_desc %}{% if currentVersion == "free-pro-team@latest"%}
repository_dispatch contenidos Permite que los integradores que utilizan GitHub Actions activen eventos personalizados.{% endif %}
estado estados {% data reusables.webhooks.status_short_desc %}
equipo members {% data reusables.webhooks.team_short_desc %}
team_add members {% data reusables.webhooks.team_add_short_desc %}
observar metadatos {% data reusables.webhooks.watch_short_desc %}