Saltar al contenido

Claves API

Las 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.

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

La página muestra dos secciones:

  • Claves RBAC — Las llaves con roles asignados (recomendado). Estas llaves utilizan el nuevo sistema de permisos basado en roles.
  • Llaves heredadas — Las 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 la Información de la llave:

    • Nombre (requerido) — Una etiqueta descriptiva para la clave (por ejemplo, “Despliegue CI/CD”, “Lectura de Monitoreo”).
    • 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ás recuperarla más tarde.
    • Establecer fecha de expiración (opcional) — Selecciona una fecha después de la cual la clave dejará de funcionar. Algunas organizaciones imponen una expiración obligatoria mediante política.
API formulario de creación de clave con nombre, opción de clave segura y expiración
  1. Seleccionar un Rol de organización — Esto define los permisos básicos de la clave en toda la organización. Los roles disponibles (dependiendo del nivel de tu propio rol):

    • Ninguno No 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, habilite Permitir crear organizaciones.

    Esto agrega el acceso global. org.create La opción está disponible cuando la clave tiene el rol de organización Admin. 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 org seleccionado no es Admin, puede agregar Acceso por aplicación:

    • Haga clic ”+ Agregar Aplicación” 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 de nivel de organización y por aplicación
  1. Click Crear.

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

One-time API key secret modal with copy button

¿Cómo gestionar (editar) una clave API?

Sección titulada '¿Cómo gestionar (editar) una clave API?'

Haga clic en el icono de llave de ajuste (Gestionar) en cualquier clave de RBAC de la lista. Esto abre la página de detalles de la clave donde puede:

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

Hacer clic “Guardar cambios” cuando se haya terminado.

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

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

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

  • Para claves seguras (hash): Se genera y se muestra una nueva clave de texto plano en un modal. Copie inmediatamente.
  • Para claves planas: El valor de la clave se regenera en el servidor.

Cualquier integración utilizando la antigua clave de valor dejará de funcionar inmediatamente.

Confirmación de regeneración de la 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á.

Confirmación de eliminación de la clave API

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

Las claves heredadas se pueden regenerar y eliminar de la lista, pero no se pueden editar para agregar roles de RBAC. Recomendamos 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 Claves API para planificar operaciones de panel de control y API, conectéalo con API Resumen General para el detalle de implementación en API Resumen General, Introducción para el detalle 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.