Saltar al contenido principal

Administrar claves de API

Una clave de API es un identificador único utilizado para la autenticación de un usuario, desarrollador o programa de llamada a una API. Las claves de API a menudo se usan para realizar un seguimiento y controlar cómo se utiliza la interfaz, para evitar el abuso de API.

Vista general de las claves de API

De forma predeterminada, las claves de API están deshabilitadas en Consola de gestión. Para habilitar las claves de API, vaya a la sección Configuración. Un administrador del espacio empresarial de inquilinos puede revocar las claves de API y editar la configuración de las claves de API, pero para generar o eliminar claves de API, debe tener el rol de desarrollador. Un administrador del espacio empresarial de inquilinos asigna el rol de desarrollador a un usuario. Si usted es administrador del espacio empresarial de inquilinos, puede asignarse el rol de desarrollador a usted mismo.

La tabla de claves de API muestra la siguiente información sobre las claves de API: nombre, ID, propietario, última actualización, fecha de creación, fecha de caducidad y estado. Utilice el campo de búsqueda para buscar en los primeros tres campos: Nombre de clave, ID de clave y Propietario.

Estados de claves de API

Las claves de API pueden tener los siguientes estados:

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

Como administrador, puede revisar las actividades de las claves de API registradas en la sección de Eventos en Consola de gestión. Si se detectan actividades sospechosas, como el uso extensivo de una determinada clave de API, puede revocar esa clave de API. Abra la lista detallada haciendo clic en la flecha situada en el extremo derecho de la tabla y copie el ID de la clave de API. Luego puede buscar el ID en la sección claves de API para hallar la clave de API que revocar.

Para revocar una única clave de API, haga clic en el botón ... situado en el extremo derecho y seleccione Revocar. Solo puede revocar claves con el estado Activo. Para revocar varias claves, marque las casillas de verificación a la izquierda de las claves para revocar y haga clic en Revocar en la esquina superior derecha. La revocación es irreversible, una clave de API revocada no se puede volver a activar.

Además de la revocación, existe la opción de eliminar. Puede eliminar una clave de API desde el centro de control, pero no en Consola de gestión.

Habilitar las claves de API en el espacio empresarial de inquilinos

El parámetro Habilitar claves de API se habilita en Consola de gestión, en la página Configuración. De forma predeterminada, las claves de API están deshabilitadas en Consola de gestión.

Propiedades de las claves de API
Propiedad Descripción
Habilitar claves de API

Este conmutador activa o desactiva todas las claves de API en el espacio empresarial de inquilinos. Solo el administrador del espacio empresarial de inquilinos puede habilitar las claves de API.

Cambiar la fecha de vencimiento máximo del token

Si cambia el valor de vencimiento del token, todos los nuevos tokens tendrán el nuevo valor de vencimiento. Las API existentes ya no se verán afectadas por el cambio, tendrán el mismo valor de vencimiento que antes.

Cambiar el máximo de claves activas de API por usuario

Este parámetro solo afecta a nuevas claves de API. Si una nueva clave de API hace que el número total exceda el máximo permitido, se deniega la creación.

Haga lo siguiente:

  1. En Consola de gestión, vaya a la página Configuración.
  2. En la sección Claves de API, active el botón Habilitar claves de API.
  3. Si procede, cambie las opciones Cambiar la fecha de vencimiento máximo del token y Cambiar el máximo de claves de API por usuario.

Generar una clave de API desde el centro de control

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

  • Está usando una licencia. Se requiere una licencia para generar una clave API.

  • El parámetro Habilitar API claves de está habilitado en Consola de gestión.
  • El administrador del espacio empresarial le ha asignado el rol de desarrollador a usted.

Haga lo siguiente:

  1. Inicie sesión en su espacio empresarial inquilino, por ejemplo, https://<nombreespacioempresarial>.com.

  2. Haga clic en su perfil en la esquina superior derecha y seleccione Configuración de perfil.

  3. Seleccione las claves de API.

  4. Haga clic en Generar nueva clave.

  5. Introduzca una descripción de la clave de API y seleccione cuándo debería caducar la clave de API.

  6. Haga clic en Generar.

    Se genera una clave de API.

  7. Copie la clave de API y almacénela en un lugar seguro.

Tras la creación, puede editar el nombre de la clave de API. También puede eliminarla.