Generación de credenciales API

Generación de credenciales API

Este artículo proporciona una guía paso a paso sobre cómo generar y gestionar credenciales de API para el portal de Lenovo Device Orchestration (LDO). Abarca el proceso de creación de un ID de cliente y clave secreta, la obtención de un Token de portador para autenticación y el acceso a diferentes terminales de API. Además, explica cómo utilizar la documentación de Swagger para explorar y probar los métodos de API disponibles.

Las credenciales de API deben ser utilizadas únicamente por administradores de TI con experiencia que comprendan claramente los endpoints de API disponibles y su funcionalidad. Antes de utilizar estas credenciales en el entorno de LDO, revise toda la documentación relevante para asegurarse de comprender cómo funcionan los endpoints. Un uso incorrecto puede tener un impacto no deseado en su entorno.

El soporte para problemas relacionados con el uso personalizado de la API, scripts y la resolución de problemas de resultados generados por la API es limitado. El soporte de LDO puede ayudar con la generación de credenciales, la autenticación y problemas documentados de la plataforma. Sin embargo, los clientes son responsables de diseñar, implementar, probar y mantener sus integraciones de API.
Debe tener una cuenta de Administración de organización en el portal LDO para generar credenciales de API.

Generar credenciales de API

Antes de utilizar las API de LDO, debe generar credenciales de API en su cuenta de LDO. Siga estos pasos:
  1. Vaya a Configuración y ajustes > Configuración de la organización > Cuenta de la organización.
  2. Seleccione Credenciales de API para abrir el panel de Credenciales. Si no hay credenciales de API, debe generarlas.
  3. Haga clic en Generar.
    1. Se generan un ID de cliente y una clave secreta. Puede copiarlos al portapapeles.
Warning
Guarde estas credenciales en un lugar seguro y vuelva a generarlas periódicamente según las políticas de seguridad de su organización.

Modificar credenciales de API

  1. Para cambiar las credenciales de API existentes, haga clic en Regenerar.
  2. En la ventana Regenerar secreto, haga clic en Regenerar.
  3. Se emiten un nuevo ID de cliente y una nueva clave secreta.
    1. El ID de cliente y la clave secreta no vencen hasta que genere un nuevo par.
  4. Después de generar sus credenciales, utilice la URL correspondiente según la región donde se encuentren los dispositivos de su organización. 
    1. NAEA: https://auth.naea1.uds.lenovo.com
    2. EU: https://auth.euwe1.uds.lenovo.com
  5. Después de generar un nuevo par de ID de cliente y clave secreta, el par anterior queda inválido.

Obtener un Token de portador

El Token de portador es un tipo de token de acceso que utiliza Auth 2.0 con un período de expiración de 30 minutos. Para obtener un nuevo token de acceso, su aplicación debe enviar este token junto con su ID de cliente al servidor de autenticación. Este proceso de verificación garantiza que solo la aplicación autorizada (aquella para la que se emitió el token de portador) pueda solicitar nuevos tokens de acceso.
  1. Generar un Token API de portador  mediante API Externa.
  2. URL: Base URL + /api/v1/auth/<organization_name>/token
  3. La URL base depende de su región: NA o EU
  4. El cuerpo de la solicitud debe estar en formato x-www-form-urlencoded y debe contener:
    1. grant_type: client_credentials
    2. client_secret: clave secreta (obtenida de la página de credenciales API)
    3. client_id: ID (obtenido de la página de credenciales API)
Genere un nuevo Token de portador cuando expire después de 30 minutos.


Explorar operaciones de API con Swagger

El archivo de especificación de Swagger contiene una carpeta con un archivo index.html y otros archivos JavaScript.
  1. Descargue el archivo ZIP Swagger Specification desde el sitio de soporte, que contiene detalles sobre cada API.
  2. Extraiga los archivos en una carpeta.
  3. Haga doble clic para abrir index.html. Verá la página principal de las APIs de LDO Información del dispositivo (LDI es legado) en Swagger.
  4. Genere un Token de portador.

Probar APIs

  1. Seleccione un método de API en Swagger.
  2. Ingrese el Token de portador en la llamada.
  3. Haga clic en Probar.

Ejemplos de métodos de API

Autenticación: Sesión de token de API

Lenovo SDK snapshot


Respuesta HTTP

Caso negativo de API: Testeo Groovy ACME

Solicitud HTTP

Respuesta HTTP