Administrar las claves de API

Las claves de API sirven como identificadores únicos para la autenticación, lo que permite a los usuarios, desarrolladores o programas acceder a una API de forma segura. Las claves de API se utilizan a menudo para rastrear y controlar la utilización de API para evitar abusos.

Vista general de las claves de API

En la sección Claves de API de Consola de gestión, puede ver todas las claves API asociadas con su espacio inquilino. Puede buscar claves por nombre, ID o propietario.

Las claves de API pueden tener los siguientes estados:

• Activo: la clave de API está actualmente en uso.
• Caducado: se ha alcanzado la fecha de caducidad.
• Revocado: la clave de API se ha revocado y ya no se puede utilizar.

Los administradores de un espacio empresarial inquilino pueden habilitar la generación de claves de API, así como supervisar y revocar claves de API. Para generar, editar o eliminar claves API, se requiere el rol de Desarrollador. Los administradores de un espacio empresarial inquilino pueden asignar este rol a los usuarios, incluidos ellos mismos.

Habilitar las claves de API en el espacio empresarial inquilino

De manera predeterminada, las claves de API están deshabilitadas. Los administradores de espacios inquilinos pueden habilitar claves de API dentro del espacio inquilino.

Haga lo siguiente:

1. En la Consola de gestión, vaya a Configuración.
2. Localice la sección de Claves de API y seleccione Habilitar claves de API.
3. Si es necesario, ajuste las siguientes configuraciones:

   • Cambiar la caducidad máxima del token: modifica la caducidad de los tokens recién generados. Las claves de API existentes conservan su valor de vencimiento original. No existe un límite máximo para este valor.

     Nota informativaEs posible que deba actualizar su navegador para ver los cambios en este valor reflejados en la sección de Claves de API de su página de perfil de usuario.
   • Cambiar el máximo de claves API activas por usuario: esta configuración afecta solo a las claves de API nuevas. Si se alcanza el límite, se denegará la creación de nuevas claves de API. El valor máximo es 1000.

4. Para comenzar a generar claves de API, haga clic en Generar nueva. Esto lo redirigirá a la sección de Claves de API en su página de perfil de usuario, donde podrá crear nuevas claves.

Generar claves de API

Puede generar claves de API desde el centro de control. Antes de comenzar, asegúrese de que se cumplan los siguientes requisitos:

• Tiene una licencia activa.

• Habilitar claves de API está activo en la Consola de gestión.
• Tiene el rol de Desarrollador.

Haga lo siguiente:

1. Haga clic en el icono de su perfil de usuario en la esquina superior derecha y seleccione Configuración de perfil.

2. En la sección Claves de API, haga clic en Generar nueva clave.

3. Proporcione una descripción y tiempo de vencimiento para la clave API.

4. Haga clic en Generar para crear la clave.

5. Copie inmediatamente la clave de API generada y guárdela de forma segura. La clave no se puede recuperar más tarde.

Después de la creación, puede editar el nombre de la clave de API o eliminarla si es necesario.

Con su clave de API, puede explorar la referencia de API REST en qlik.dev usando herramientas como Postman o instalar qlik-cli para acceder a las capacidades de Qlik directamente desde la línea de comandos. Para más información, vea Vista general de las API de Qlik y qlik-cli.

Supervisar y revocar claves de API

Como administrador de espacios empresariales inquilinos, es esencial supervisar las actividades de las claves de API por motivos de seguridad. Si se detectan actividades sospechosas, puede revocar la clave de API.

Recuerde que revocar una clave de API la desactivará inmediatamente, lo que afectará a cualquier proceso o integración en curso que dependa de ella. La revocación es irreversible y una clave de API revocada no se puede reactivar.

Haga lo siguiente:

1. En la Consola de gestión, vaya a la sección Eventos.

2. Busque actividades sospechosas, como el uso excesivo de una clave API en particular.

3. Haga clic en junto al evento para ampliar sus detalles y copiar el ID de la clave API.

4. Vaya a la sección de Claves de API y busque la clave de API por su ID.

5. Haga clic en junto a la clave y seleccione Revocar. Sólo puede revocar claves con estado Activo.

6. Para revocar varias claves de API, selecciónelas en la tabla y haga clic en Revocar en la esquina superior derecha.

Eliminar claves de API

La eliminación de claves de API las elimina permanentemente del sistema. Eliminar una clave de API es irreversible y eliminará inmediatamente sus privilegios de acceso. Asegúrese de que esta acción no interrumpa ningún proceso o integración en curso que dependa de la clave.

Necesita el rol de Desarrollador para eliminar claves de API.

Haga lo siguiente:

1. Haga clic en el icono de su perfil de usuario en la esquina superior derecha y seleccione Configuración de perfil.

2. Seleccione la sección Claves de API.

3. Haga clic en junto a la clave de que desee eliminar y seleccione Eliminar.

4. Si desea eliminar todas las claves, haga clic en Eliminar todo encima de la lista de claves de API.