API Claves

Las API claves utilizan el control de acceso basado en roles (RBAC). Una clave puede tener un rol organizativo, vinculaciones de aplicación o ambos. Cada vinculación de aplicación permanece asociada con la organización propietaria de la aplicación. Para el privilegio mínimo, restrinja una clave a aplicaciones seleccionadas en lugar de asignar un rol organizativo.

Dónde se gestionan las API claves?

Navegue a Ajustes > Organización > Claves API a console.capgo.app/settings/organization/api-keys.

La página muestra dos secciones:

• Claves de RBAC Claves con roles asignados (recomendado). Estas claves utilizan el nuevo sistema de permisos basado en roles.
• Claves Heredadas — Claves más antiguas que utilizan el sistema basado en modo simple (read, upload, write, all) sin asignaciones de roles.

¿Cómo crear una nueva claves API?

1. Haga clic en el ”+” botón en la parte superior de la tabla de claves de RBAC.

2. Rellene la Información de la clave:

   • Nombre (obligatorio) — Un rótulo descriptivo para la clave (por ejemplo, “Despliegue CI/CD” o “Lectura de Monitoreo Solo”).
   • Crear una clave segura (opcional) — Cuando se marca, la clave se cifra en el lado del servidor. La clave en texto plano se muestra solo una vez solo una vez después de la creación y no puede recuperarse más tarde.
   • Establecer fecha de expiración (opcional) — Selecciona una fecha a partir de la cual la clave deja de funcionar. Algunas organizaciones imponen la expiración obligatoria a través de políticas.

3. Seleccione el alcance de la clave:

   • Acceso organizativo — Seleccione un Rol de organización para definir los permisos básicos a lo largo de la organización. Los roles disponibles dependen del nivel de su propio rol:
     • Ninguno — Sin acceso organizativo en general.
     • Miembro — Acceso de lectura básico a la organización.
     • Administrador — Acceso administrativo completo a la organización y a todas sus aplicaciones.
   • Acceso solo para aplicaciones — Habilitar Limitar esta clave a aplicaciones seleccionadas. Cada vinculación de aplicación permanece vinculada a la aplicación que la posee; este modo omite solo un rol de RBAC organizativo en general.

4. Si la clave necesita crear organizaciones a través del API público, habilitar Permitir crear organizaciones.

   Esta agrega la autorización global. org.create permiso. La clave también necesita una organización con alcance org_admin o org_super_admin permiso. La clave también necesita una organización con alcance o permiso. La clave también necesita una organización con alcance org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. permiso. La clave también necesita una organización con alcance

   • o permiso. La clave también necesita una organización con alcance o permiso. La clave también necesita una organización con alcance o una organización con alcance. En el panel de control, seleccionar "Admin" crea la vinculación. Cuando esta clave crea una nueva organización, __CAPGO_KEEP_0__ asigna automáticamente la clave como Super Admin en esa nueva organización. Para conceder acceso a la aplicación: Cuando se habilita "Limitar esta clave a aplicaciones seleccionadas", elija una organización bajo "Organizaciones para filtrar aplicaciones". para revelar sus aplicaciones. Las vinculaciones de la aplicación seleccionada permanecen asociadas con sus organizaciones propietarias; este filtro no concede acceso organizativo en general.
   • Haz clic ”+ Agregar aplicación”, selecciona una o más aplicaciones, luego asigna un rol a cada:
     • Leer aplicación — Acceso de solo lectura a la aplicación.
     • Subir aplicación — Puede subir nuevos conjuntos de paquetes.
     • Desarrollador de aplicación — Puede subir conjuntos de paquetes, gestionar dispositivos, desencadenar compilaciones nativas y actualizar configuraciones de canal.
     • Administrador de aplicación — Acceso completo a la aplicación.
     • Vista de la aplicación — Vista la vida cíclica de CI/CD: subir un paquete y crear un canal de vista previa. El canal recibe derechos de vida cíclica automáticamente, solo para este canal.

6. Haga clic “Crear”.

7. Si seleccionó Crear una clave segura, se muestra un diálogo con la clave en texto plano. Copiarlo inmediatamente — no se puede recuperar después de cerrar el diálogo.

Use una clave de vista previa de la aplicación para flujos de trabajo de vista previa

Utilice Vista previa de la aplicación para CI que crea un canal de vista previa temporal y no público, sube y promueve un paquete, y luego elimina tanto el canal como el paquete. No tiene acceso a la vida cíclica de un canal predeterminado o principal existente.

1. Crear una clave de RBAC y habilitar Limitar esta clave a aplicaciones seleccionadas.
2. Bajo Organizaciones para filtrar aplicaciones, seleccione la organización para revelar sus aplicaciones; cada aplicación seleccionada permanece asociada con su organización propietaria.
3. Agregar solo la aplicación o aplicaciones utilizadas para despliegues de vista previa.
4. Seleccione Vista previa de la aplicación para cada aplicación seleccionada.
5. Crea una clave segura, establece una fecha de expiración cuando sea apropiado y almacénala en tu administrador de secretos de CI.

Este modo solo para aplicaciones seleccionadas omite un rol organizativo; no elimina la asociación de la organización. Cada vinculación permanece escopada a su aplicación seleccionada y a la organización propietaria de esa aplicación. app_preview Otorga

permisos y límites	en la aplicación seleccionada
app_preview , y	app.read, app.read_bundles, app.upload_bundlela unión automática app.create_channel.
vinculación channel_preview Cuando esta clave crea un canal, __CAPGO_KEEP_0__ da automáticamente la clave	When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundley channel.delete para ese canal solo.

app_preview retiene app.read, por lo tanto, la clave puede enumerar los metadatos del canal en la aplicación seleccionada. La vinculación automática de hijos es un gestión límite: no concede mutaciones de ciclo de vida para canales que la clave no creó.

Capgo también registra qué clave de vista previa de la aplicación subió un paquete. La clave puede establecer solo su propio paquete en cada canal de vista previa que crea y puede limpiar esa pareja juntos. No recibe una vinculación de canal para un canal predeterminado o principal existente, un canal creado por otra clave de vista previa o un paquete de otra clave.

Para un trabajo de CI típico, utilice un nombre de canal único por solicitud de extracción:

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

Para un nuevo canal, bundle upload --channel crea el canal, sube el paquete y lo promociona en un flujo. El último comando utiliza una ruta de limpieza atómica estrecha: solo tiene éxito cuando la clave es dueña del canal de vista previa y su paquete vinculado y no compartido. Vista de la Aplicación todavía no tiene acceso general bundle.deletepor lo tanto no puede eliminar un paquete arbitrario.

Advertencia

Utilice un nuevo canal no público. pr-<number> No pase opciones de lanzamiento o --default, --self-assigna este flujo de trabajo. Una --delete-linked-bundle-on-upload Vista de la Aplicación clave no puede promover, eliminar o cambiar un canal existente predeterminado/principal, un canal de otra clave de vista previa o un paquete de otra clave. Revocar o vencer la vinculación de la aplicación también elimina el acceso de ciclo de vida efectivo de la clave. Consulte el

See the Referencia de Control de Acceso para la frontera completa.

Cómo gestionar (editar) una API clave?

Haga clic en el ícono de llave inglesa (Administrar) en cualquier clave de RBAC en la lista. Esto abre la página de detalles de la clave donde puede:

• Cambiar el nombre de la clave actualizar el.
• rol de organización Habilitar o deshabilitar.
• icon Permitir la creación de organizaciones cuando la clave tiene un rol de organización administrador.
• Agregar, eliminar o cambiar roles por aplicación.

Haga clic “Guardar cambios” cuando esté listo.

¿Cómo regenerar una clave API?

Para regenerar el valor secreto de una clave API, haga clic en el ícono de refresco (Regenerar) en cualquier clave de la lista.

Se mostrará un diálogo de confirmación. Después de confirmar:

• Para claves seguras (hashadas): Se genera y se muestra una nueva clave de texto plano en una ventana emergente. Copiela inmediatamente.
• Para claves planas: El valor de la clave se regenera en el servidor.

Cualquier integración que utilice el antiguo valor de la clave dejará de funcionar inmediatamente.

¿Cómo eliminar una clave API?

Haga clic en el ícono de basura (Eliminar) en cualquier clave de la lista. Confirme la eliminación en el diálogo.

La clave se revoca inmediatamente — cualquier solicitud que la utilice fallará.

Claves obsoletas

Si ve claves en la Sección de claves obsoletas sección (claves sin asignaciones de roles), estas utilizan el sistema de permisos basado en modo más antiguo (read, upload, write, allLas claves obsoletas aún funcionan, pero no aprovechan las permisos de RBAC finamente detallados.

Las claves obsoletas pueden ser regeneradas y eliminadas de la lista, pero no pueden ser editadas para agregar roles de RBAC. Recomendamos crear nuevas claves de RBAC y eliminar claves obsoletas cuando sea posible.

Si necesita administrar claves legadas directamente, puede acceder a ellas en console.capgo.app/dashboard/apikeysEsta página está descontinuada y se eliminará en una actualización futura.

Siga adelante desde Claves API

Si está utilizando Claves API para planificar la consola y las operaciones de API, conecte con Vista general de API para obtener detalles de implementación en Vista general de API Introducción para obtener detalles de implementación en Introducción API Claves para el detalle de implementación en API Claves Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.