Administrar las claves de API
Las claves de API son identificadores únicos que se utilizan para la autenticación y que permiten a los usuarios, desarrolladores o programas acceder a las API de forma segura. Son esenciales para rastrear y controlar el uso de las API, ayudando a evitar abusos y garantizando una comunicación segura.
Usar claves de API para conectarse a las API de Qlik Cloud
Puede usar claves de API para interactuar con la referencia de la API REST en qlik.dev. Herramientas como Postman o qlik-cli pueden usarse para el acceso a la API. Para más información, vea Vista general de las API de Qlik y qlik-cli.
Ejemplo: usr Postman para conectarse a las API de Qlik
Haga lo siguiente:
-
Inicie Postman.
-
Configure el método HTTP como GET.
-
Agregue la URL del punto de conexión de la API Qlik Cloud.
Por ejemplo, para mostrar todos los espacios del espacio empresarial inquilino:
https://your-tenant.eu.qlikcloud.com/api/v1/spaces
-
En la pestaña Auth, seleccione Token de portador como Tipo de autenticación.
-
Inserte su clave de API en el campo Token.
-
Haga clic en Enviar.
Si la solicitud es correcta, la API devolverá una respuesta JSON. En este ejemplo, la respuesta incluiría una lista de espacios.
Habilitar las claves de API en el espacio empresarial inquilino
De manera predeterminada, la generación de claves de API está deshabilitada. Los administradores del espacio empresarial inquilino deben habilitar las claves de API en el espacio empresarial inquilino para permitir que los usuarios las generen.
Haga lo siguiente:
- En el centro de actividades Administración, vaya a Configuración.
- En Claves de API, seleccione Habilitar Claves de API.
-
Ajuste las siguientes configuraciones según sea necesario:
-
Cambiar la fecha de vencimiento máximo del token: modifique la caducidad de los tokens recién generados. Las claves de API existentes conservarán su valor de caducidad original. No existe un límite máximo para este valor.
- Cambiar el máximo de claves de API activas por usuario: este límite sólo se aplica a las nuevas claves de API. Si se alcanza el límite, se denegará la creación de claves de API adicionales. El valor máximo que puede establecer es 1000.
Nota informativaEs posible que deba actualizar su navegador para ver los cambios reflejados en la sección de Claves de API de su página de perfil de usuario. -
-
Para empezar a generar nuevas claves de API, haga clic en Generar nueva. Se le redirigirá a la sección de Claves de API de su perfil de usuario.
Generar y administrar claves de API
Generar claves de API
Para generar nuevas claves de API, debe tener el rol de Desarrollador. Los administradores de espacios empresariales inquilinos pueden asignar este rol a los usuarios.
Haga lo siguiente:
-
Haga clic en el icono de su perfil de usuario y seleccione Configuración de perfil.
-
Vaya a la sección Claves de API y haga clic en Generar nueva clave.
-
Proporcione una descripción y establezca una hora de caducidad para la clave de API.
-
Haga clic en Generar para crear la clave.
-
Copie la clave API generada y almacénela de forma segura. Nota: la clave no se puede recuperar más tarde.
Editar claves de API
Puede cambiar el nombre de una clave de API después de su creación.
Eliminar claves de API
Haga lo siguiente:
-
Haga clic en el icono de su perfil de usuario y seleccione Configuración de perfil.
-
Vaya a la sección Claves de API.
-
Haga clic en junto a la clave de que desee eliminar y seleccione Eliminar.
-
Para eliminar todos, haga clic en Eliminar todos sobre la lista de claves.
Supervisar y revocar claves de API
Puede ver todas las claves de API asociadas a su espacio empresarial inquilino en la sección Claves de API del centro de actividades Administración. Puede buscar claves por nombre, ID o propietario.
Estados de la clave de API
Las claves de API pueden tener los siguientes estados:
- Activa: la clave de API está siendo utilizada en este momento.
- Caducada: se ha alcanzado la fecha de caducidad.
- Revocada: la clave de API se ha revocado y ya no puede utilizarse.
Revocar claves de API
Como administrador de un espacio empresarial inquilino, supervisar activamente las actividades de las claves de API es esencial para mantener la seguridad. Si se detectan actividades sospechosas, puede revocar la clave de API.
Haga lo siguiente:
-
En el centro de actividades Administración, vaya a Eventos.
-
Busque actividades sospechosas, como el uso excesivo de una clave API en particular.
-
Haga clic en junto al evento para ampliar sus detalles y copiar el ID de la clave API.
-
Vaya a la sección de Claves de API y busque la clave de API por su ID.
-
Haga clic en junto a la clave y seleccione Revocar. Sólo puede revocar claves con estado Activo.
-
Para revocar varias claves de API, selecciónelas en la tabla y haga clic en Revocar en la esquina superior derecha.
Mejores prácticas para la gestión de claves de API
-
Mantenga la confidencialidad de las claves: almacene las claves de API de forma segura y evite exponerlas en repositorios públicos de código.
-
Regenere periódicamente: regenere de forma periódica sus claves de API para mejorar la seguridad.
-
Supervise el uso: compruebe regularmente las actividades de las claves de API para identificar cualquier comportamiento sospechoso.