Générer des identifiants API

Générer des identifiants API

Cet article fournit un guide étape par étape pour générer et gérer des identifiants API dans le portail Lenovo Device Orchestrations (LDO). Il décrit le processus de création d’un identifiant client (Client ID) et d’une clé secrète (Secret Key), l’obtention d’un jeton Bearer pour l’authentification, ainsi que l’accès aux différents points de terminaison de l’API. Il explique également comment utiliser la documentation Swagger pour explorer et tester les méthodes API disponibles.

Les identifiants API doivent être utilisés uniquement par des administrateurs informatiques expérimentés ayant une compréhension claire des points de terminaison (endpoints) API disponibles et de leur fonctionnalité. Avant d'utiliser ces identifiants dans l'environnement LDO, consultez toute la documentation pertinente afin de comprendre le fonctionnement des points de terminaison. Une utilisation incorrecte peut avoir des conséquences inattendues sur votre environnement.

La prise en charge des problèmes liés à l'utilisation d'API personnalisées, aux scripts et au dépannage des résultats générés par l'API est limitée. Le support LDO peut vous aider concernant la génération des identifiants, l'authentification et les problèmes documentés de la plateforme. Cependant, les clients sont responsables de la conception, de la mise en œuvre, des tests et de la maintenance de leurs intégrations API.
Notes
Vous devez disposer d’un compte d’Administrateur d’organisation dans le portail LDO pour générer des identifiants API.

Générer des identifiants API

Avant d’utiliser les API LDO, vous devez générer des identifiants API dans votre compte LDO. Procédez comme suit :
  1. Accéder à Organisation et paramètres > Paramètres de l’organisation > Compte de l’organisation.
  2. Sélectionner Identifiants API pour ouvrir le volet Identifiants. Si aucun identifiant API n'existe, vous devez en générer.
  3. Cliquer sur Générer.
     Un ID client et une clé secrète sont générés. Vous pouvez les copier dans le presse-papiers.
Alert
Important : Conservez ces identifiants dans un emplacement sécurisé et régénérez-les régulièrement conformément aux politiques de sécurité de votre organisation.

Modifier des identifiants API

  1. Pour modifier des identifiants API existants, cliquer sur Régénérer.
  2. Dans la fenêtre Régénérer la clé secrète, cliquer sur Régénérer.
  3. Un nouvel ID client et une nouvelle clé secrète seront générés.
    L'ID client et la clé secrète n'expirent pas tant que vous ne régénérez pas une nouvelle paire d'identifiants.
  4. Après avoir généré vos identifiants, utilisez l'URL appropriée en fonction de la région où se trouvent les dispositifs de votre organisation :
    1. NAEA : https://auth.naea1.uds.lenovo.com
    2. EU : https://auth.euwe1.uds.lenovo.com
Info
Remarque : Après la génération d'une nouvelle paire d'ID client et de clé secrète, l'ancienne paire devient invalide.

Obtenir un jeton Bearer

Le jeton Bearer est un type de jeton d’accès utilisant OAuth 2.0, avec une période d’expiration de 30 minutes.
Pour obtenir un nouveau jeton d’accès, votre application doit envoyer ce jeton Bearer, accompagné de votre identifiant client, au serveur d’authentification. Ce processus de vérification garantit que seule l’application autorisée (celle pour laquelle le jeton Bearer a été initialement émis) peut demander de nouveaux jetons d’accès.
  1. Générer un jeton Bearer via une API externe
  2. URL : URL de base + /api/v1/auth/<organization_name>/token
  3. L’URL de base dépend de votre région (NA ou EU).
  4. Le corps de la requête doit être au format x-www-form-urlencoded et contenir les éléments suivants :
    1. grant_type : client_credentials
    2. client_secret : clé secrète (depuis la page des identifiants API)
    3. client_id : identifiant client (depuis la page des identifiants API)
Notes
Générez un nouveau jeton Bearer à chaque expiration, soit toutes les 30 minutes.
selectedImg

selectedImg

Explorer les opérations API avec Swagger

L’archive de spécification Swagger contient un dossier avec un fichier index.html et d’autres fichiers JavaScript.
  1. Téléchargez le fichier Zip de spécification Swagger, qui fournit des détails sur chaque API.
  2. Extrayez les fichiers dans un dossier.


  3. Double-cliquez sur le fichier index.html pour l’ouvrir. La page d’accueil des API LDO Device Insights (LDI correspond à l’ancienne version) s’affiche dans Swagger.

    selectedImg
  4. Générez un jeton Bearer.

Tester les API

  1. Sélectionnez une méthode API dans Swagger.
  2. Utilisez le jeton Bearer dans l’appel.
  3. Cliquez sur Try it out.

Exemples de méthodes API

Authentification – Session de jeton API

Lenovo SDK snapshot

selectedImg
selectedImg

HTTP Response

Negative API Sample:  Groovy ACME Test


HTTP Request
selectedImg
HTTP Response
selectedImg