Claves API de Servicio

Las Claves API de Servicio son credenciales de nivel de plataforma para autenticación servicio a servicio. Son distintas de las claves API del tenant y están destinadas a servicios backend confiables o integraciones que necesitan acceso directo a la API sin una sesión de usuario. Los administradores del sistema generan, rotan y revocan estas claves desde el portal de administración del sistema.

Acceso a la Página

• Ruta: /service-api-keys
• Ruta de Menú: Configuración → Sistema → Claves API de Servicio
• Audiencia principal: Solo administradores del sistema. Estas páginas se acceden mediante el inicio de sesión de administrador del sistema en system.portal.net — no el portal del tenant.

Qué puedes hacer aquí

• Ver todas las claves API de servicio con nombre de servicio, estado (Activo, Revocado, Expirado), fecha de creación, fecha de expiración y marca de tiempo de último uso.
• Generar una nueva clave API y copiar el secreto de una sola vez antes de que sea enmascarado.
• Revocar una clave para bloquear inmediatamente cualquier servicio que la utilice.
• Filtrar claves por estado (Activo / Revocado / Expirado) y estado de expiración (Válido / Expirado / Expirando Pronto).
• Buscar claves por nombre de servicio o descripción.

Tareas comunes

1. Abre Configuración → Sistema → Claves API de Servicio en system.portal.net.
2. Haz clic en Generar Nueva Clave API para abrir el formulario de generación.
3. Ingresa el nombre del servicio y opcionalmente una descripción y fecha de expiración.
4. Haz clic en Generar — un modal muestra el secreto de la clave. Cópialo inmediatamente; no se mostrará de nuevo.
5. Guarda el secreto en tu bóveda de implementación o gestor de secretos.
6. Pasa la clave en el encabezado Authorization de las solicitudes de API servicio a servicio.

Notas

• El secreto se muestra solo una vez, inmediatamente después de la generación. Si se pierde, revoca la clave y genera un reemplazo.
• Revocar una clave es permanente e inmediato — el servicio pierde acceso en el momento en que se confirma la revocación.
• Una clave expirada es tratada automáticamente como inactiva. Su badge de estado cambia a Expirado y el servicio ya no puede autenticarse.
• Usa nombres de servicio claros y descriptivos (ej., inventory-service, erp-sync) para identificar las claves al auditar o revocar.
• Guarda los secretos en una bóveda de secretos aprobada. Nunca confirmes secretos en el control de código fuente ni en archivos de configuración.

Generar una Clave API de Servicio

Haz clic en Generar Nueva Clave API en el encabezado de la página. Se abre un formulario de página completa donde configuras la clave antes de generar el secreto.

Campos

Campo	Requerido	Tipo	Descripción	Predeterminado	Validación
Nombre del Servicio	Sí	Texto	Identificador único para el servicio que usará esta clave (ej., inventory-service)	—	Requerido; se usa como nombre para mostrar en la lista
Descripción	No	Área de texto	Notas opcionales sobre el propósito y uso de la clave	—	Máx. 1000 caracteres
Fecha de Expiración	No	Fecha	Fecha después de la cual la clave deja de funcionar. Dejar vacío para una clave que nunca expira	—	Debe ser una fecha futura

Pasos:

1. Haz clic en Generar Nueva Clave API en el encabezado de la página.
2. Ingresa un Nombre del Servicio descriptivo que identifique el servicio consumidor.
3. Opcionalmente agrega una Descripción que explique el propósito de la clave.
4. Opcionalmente establece una Fecha de Expiración para limitar la vida útil de la clave.
5. Haz clic en Generar. Un modal muestra inmediatamente el secreto generado.
6. Haz clic en el icono de copiar para copiar el secreto al portapapeles. Guárdalo de forma segura — no se mostrará de nuevo.
7. Haz clic en Cerrar para cerrar el modal y volver a la lista de claves.

Revocar una Clave API de Servicio

Revocar desactiva permanentemente una clave. Cualquier servicio que use la clave pierde acceso de inmediato.

1. Abre las acciones de fila (menú de tres puntos) en la fila de una clave activa.
2. Selecciona Revocar Clave.
3. Lee la confirmación: “¿Está seguro de que desea revocar la clave API para [nombre del servicio]? Esta acción no se puede deshacer y el servicio ya no podrá autenticarse.”
4. Haz clic en Revocar Clave para confirmar — el estado de la clave cambia a Revocado en la lista.

Nota: Las claves revocadas no pueden reactivarse. Genera una nueva clave y actualiza la configuración del servicio consumidor para restaurar el acceso.

Páginas Relacionadas

• Claves API — claves API con alcance de tenant gestionadas en la configuración de Datos y Monitoreo
• Gestión de Inquilinos — organizaciones inquilinas con las que las claves API de servicio pueden interactuar