Pular al contenido

API Claves

API se gestionan a nivel de organización con control de acceso basado en roles (RBAC). Cada clave puede asignarse un rol organizativo y roles opcionales por aplicación, lo que te da un control fino sobre qué cada clave puede acceder.

Navegar a Configuración > Organización > Claves API en consola.capgo.app/configuración/organización/api-llaves.

La página muestra dos secciones:

  • Llaves de RBAC — Llaves con roles asignados (recomendado). Estas llaves utilizan el nuevo sistema de permisos basado en roles.
  • Llaves de legado — Llaves más antiguas que utilizan el sistema de modo simple (read, upload, write, all) sin asignaciones de roles.
Página de lista de llaves API mostrando secciones de RBAC y Legado
  1. Haga clic en el ”+” botón en la parte superior de la tabla de llaves de RBAC.

  2. Rellene el Información clave:

    • Nombre (obligatorio) — Una etiqueta descriptiva para la clave (por ejemplo, “Despliegue CI/CD”, “Consulta de monitoreo de solo lectura”).
    • Crear clave segura (opcional) — Cuando se marca, la clave se cifrará en el lado del servidor. La clave en texto plano se muestra solo una vez después de la creación. No podrá recuperarla más tarde.
    • Establecer fecha de caducidad (opcional) — Seleccione una fecha después de la cual la clave dejará de funcionar. Algunas organizaciones imponen una caducidad obligatoria mediante política.
API formulario de creación de clave con nombre, opción de clave segura y caducidad
  1. Seleccione un Rol de la organización — Esto define las permisos básicos de la clave a lo largo de toda la organización. Roles disponibles (dependiendo del nivel de rol propio):

    • Ninguno — Sin acceso organizacional; la clave solo tiene acceso a aplicaciones asignadas individualmente.
    • Miembro — Acceso de lectura básico a la organización.
    • Administrador — Acceso administrativo completo a la organización (hereda acceso a todas las aplicaciones).
  2. Si la clave necesita crear organizaciones a través del API público, habilite Permitir la creación de organizaciones.

    Esto agrega el permiso global. org.create Está disponible cuando la clave tiene un rol de administrador de organización. Cuando esta clave crea una nueva organización, Capgo asigna automáticamente la clave como Super Administrador en esa nueva organización.

  3. Si el rol de la organización seleccionado no es Administrador, puede agregar acceso por aplicación:

    • Haga clic en ”+ Add App” para abrir el selector de aplicaciones.
    • Seleccione una o varias aplicaciones, luego asigne un rol a cada una:
      • Lector de Aplicación — Acceso de solo lectura a la aplicación.
      • Subidor de Aplicación — Puede subir nuevos paquetes.
      • Desarrollador de Aplicación — Puede gestionar la configuración y las implementaciones de la aplicación.
      • Administrador de Aplicación — Acceso completo a la aplicación.
Selección de rol de RBAC con roles a nivel de organización y por aplicación
  1. Hacer clic “Crear”.

  2. Si seleccionó “Crear clave segura”, se mostrará un modal con la clave en texto plano. Copiarla inmediatamente — no se puede recuperar después de cerrar el modal.

Modal de clave secreta de una sola vez API con botón de copiar

Hacer clic icono de llave inglesa (Administrar) en cualquier clave de RBAC en la lista. Esto abre la página de detalles de la clave donde puedes:

  • Cambiar la clave nombre.
  • Actualizar el rol de organización.
  • Habilitar o deshabilitar Permitir crear organizaciones cuando la clave tiene un rol de organización de Administrador.
  • Agregar, eliminar o cambiar roles por aplicación.

Hacer clic “Guardar cambios” cuando estés listo.

API clave de edición de página con configuraciones de rol actuales

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

Un diálogo de confirmación aparecerá. Después de confirmar:

  • Para claves seguras (hasheadas): Se genera y muestra una nueva clave de texto plano en una ventana emergente. Cópiala inmediatamente.
  • Para llaves planas: El valor de la llave se regenera en el lado del servidor.

Cualquier integración que utilice el valor de la llave antiguo dejará de funcionar de inmediato.

Confirmación de regeneración de la llave API

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

La llave se revoca de inmediato — cualquier solicitud que la utilice fallará.

Diálogo de confirmación de eliminación de la llave API

Si ve claves en el Claves Heredadas sección (claves sin asignaciones de roles), estas utilizan el sistema de permisos basado en modo (read, upload, write, all). Aún funcionan, pero no benefician de las permisos de RBAC finamente detallados.

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

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

Si está utilizando API Claves para planificar la consola y las operaciones de API API Overview API Resumen para obtener detalles de implementación en __CAPGO_KEEP_0__ Resumen Introducción API Keys API Claves para obtener detalles de implementación en __CAPGO_KEEP_0__ Claves Dispositivos para obtener detalles de implementación en Dispositivos para los detalles de implementación en Bundles.