Gestión de Claves API (API Key Manager)

Token, Integraciones, Permisos, Control de accesos, Monitoreo, Revocación

Descripción: Herramienta esencial para la creación, visualización y gestión de los tokens de acceso (API Key) utilizados para conectar Framework360 con servicios y aplicaciones externas.

¿Para qué sirve? (Ejemplos prácticos)

Esta herramienta es fundamental cuando se necesita hacer interactuar Framework360 con sistemas externos de manera controlada y segura.

  • Integración con Software de Terceros: Úsalo para generar una clave dedicada que permita a un software de contabilidad o a un conector de datos (ETL) acceder solo a las funciones necesarias (ej. lectura de pedidos).
  • Desarrollo de Apps Móviles/Web Personalizadas: Útil para crear un token que permita a una aplicación móvil desarrollada ad hoc realizar llamadas específicas (ej. registro de un nuevo usuario) dentro del sistema.
  • Control de Accesos: Permite limitar exactamente qué operaciones (ej. modificación, creación, lectura) pueden ser ejecutadas por cada integración individual, aumentando la seguridad del sistema.

Funcionalidades principales

1. Gestión de las Claves

  • Creación Sencilla: Es posible generar una nueva clave API con un solo clic, proporcionando un nombre descriptivo. El sistema genera automáticamente un Token único de 40 caracteres.
  • Monitoreo: La lista principal muestra la última fecha de uso de cada clave, permitiendo identificar rápidamente las claves inactivas o las que se usan frecuentemente.
  • Eliminación: Permite revocar inmediatamente el acceso eliminando la clave.

2. Configuración de Permisos (Granularidad)

El aspecto más importante es la posibilidad de definir con precisión lo que puede hacer cada clave.

  • Definición de Funciones: A través de una estructura en pestañas y casillas, el usuario puede seleccionar qué funciones API específicas (ej. creacliente, eliminaprodotto, leggi_campagna) están habilitadas para ese Token.
  • Selección Múltiple: Está disponible un botón "Seleccionar todo" para habilitar rápidamente todas las funciones.

Cómo se configura

Cuando se modifica una clave API, se accede a la pantalla de configuración dividida en dos secciones principales: Configuraciones Generales y Permisos.

Configuraciones Generales

OpciónDescripción
Api KeyEl Token único generado por el sistema. Debe proporcionarse a la aplicación externa.
Fecha de creaciónFecha en que fue generada la clave.
Solicitar autenticación del usuarioSi esta opción está activa, la clave API no será suficiente por sí sola. Cada llamada API deberá incluir también un Token de sesión válido del usuario (mediante el encabezado X-Fw360-UserToken).

Gestión de Permisos por Rol

El sistema de gestión de permisos está organizado por Roles de Usuario. Esto permite definir conjuntos diferentes de permisos según el contexto en que se utilice la clave.

1. Navegación por Pestañas: Las pestañas (o "steps") en la sección Permisos corresponden a los distintos Roles configurados en el sistema (ej. Administrador, Cliente, Agente).

2. Asignación de Funciones: Dentro de cada pestaña, es posible seleccionar las funciones API a habilitar.

3. Limitación por Rol: Para roles distintos al Administrador, el sistema avisa que las llamadas realizadas con esa clave también respetarán las limitaciones ya establecidas para ese Rol en el módulo Gestión de Roles.

4. Seguridad Adicional (Icono Candado): Junto a algunas funciones API puede aparecer un ícono en forma de candado. Si está seleccionado, significa que esa función específica, aunque esté habilitada por la clave API, requerirá obligatoriamente que la llamada vaya acompañada por una autenticación válida del usuario (incluso si no está activa la opción general "Solicitar autenticación del usuario").

Integraciones automáticas

Este módulo es el punto de acceso para todas las integraciones externas. Su configuración influye directamente en la capacidad de sistemas externos para interactuar con los datos y funcionalidades de Framework360.

Control del Acceso del Usuario: Si se habilita la opción "Solicitar autenticación del usuario", la clave API no solo autentica la aplicación sino que también vincula la llamada con los permisos específicos del usuario que está usando la aplicación externa. Esto garantiza que, por ejemplo, un cliente pueda leer solo sus propios datos, incluso si la clave API está configurada para acceso genérico.