Gestión de claves de API REST de plataforma

Crea claves API asociadas a tu cuenta de usuario y, a continuación, utilízalas para autenticarte cuando llames a las API REST de la plataforma proporcionadas por API Connect.

Acerca de esta tarea

Las API Connect API REST de la plataforma requieren autenticación para su uso. Para llamar a una API de forma interactiva, puede iniciar sesión en la CLI del kit de herramientas con una opción para generar la clave de API. Para llamar a una API mediante programación, puedes generar una clave de API y luego intercambiarla por un API Connect token de acceso. Este requisito sólo se aplica a las API que proporciona API Connect. No necesita la clave de API para llamar a las API que haya importado o creado. La clave API está pensada para su uso con el tipo de registro de usuario OIDC.
Recuerde: Por defecto, las claves API están configuradas para ser utilizadas una sola vez Sin embargo, puede personalizar la configuración y modificar la vida útil de la API siguiendo los pasos que se indican en el tema Configuración de los ajustes de la clave de API

Procedimiento

  1. Cree una clave de API:
    1. Inicie sesión en API ConnectEmpresa como servicio.
    2. Pulse el nombre de usuario en el banner para visualizar el perfil.
    3. En la página de perfil, pulse Mis claves de API.
    4. En la página Claves de API , pulse Añadir.
    5. En el campo Crear clave API de API Connect, introduzca un título para la clave y una descripción. El título debe ser único dentro de su cuenta de usuario.
    6. Para especificar un valor de tiempo de espera, seleccione o escriba un valor entero en el campo Tiempo de espera de la clave API y, a continuación, elija una unidad de tiempo (Segundos, Minutos u Horas) en el campo Unidad.
      Nota: El tiempo de espera por defecto es de 5 minutos.
    7. Seleccione Activar uso múltiple para permitir que las aplicaciones intercambien la clave API por un token de acceso varias veces.
    8. Haga clic en Crear.
      Nota: El botón Crear está desactivado hasta que proporcione una descripción.
  2. Gestionar claves de API:
    1. Inicie sesión en API ConnectEmpresa como servicio.
    2. Pulse el nombre de usuario en el banner para visualizar el perfil.
    3. En la página de perfil, pulse Mis claves de API.
      Aparece la lista de Claves API asociadas a su cuenta de usuario:
      • Para ver una clave, haga clic en Ver la clave de API en la misma fila que el título de la clave.
      • Para copiar una clave, visualícela y seleccione Copiar la clave de API en el campo Clave API.
      • Para eliminar una clave, haga clic en Suprimir la clave de API en la misma fila que el título de la clave y haga clic en Eliminar cuando se le pida que confirme la acción.