この記事では、Lenovo Device Operations (LDO) ポータルの API 資格情報を生成および管理する方法をステップバイステップで説明します。クライアント ID と秘密鍵の作成、認証用のベアラー・トークンの取得、さまざまな API エンドポイントへのアクセスのプロセスについて説明します。さらに、Swagger ドキュメントを使用して、使用可能な API メソッドを探索およびテストする方法についても説明します。
API 資格情報を生成するには、LDO ポータルの組織管理アカウントが必要です。
API 資格情報の生成
LDO API を使用する前に、LDO アカウントで API 資格情報を生成する必要があります。以下の手順に従ってください。
上部のナビゲーション・ドロップダウン・メニューから「デバイス・インサイト」をクリックします。
「構成 / デバイス・インサイト設定」に移動します。
- 「API 資格情報」をクリックして、「資格情報」パネルを開きます。
API 資格情報がない場合は、生成する必要があります。 - 「生成」をクリックします。
クライアント ID と秘密鍵が生成されます。クリップボードにコピーできます。 - これらの資格情報を安全な場所に保存し、組織のセキュリティー・ポリシーに従って定期的に再生成します。
- 既存の API 資格情報を変更する場合は、新しい資格情報を生成する必要があります。
「再生成」をクリックします。
「シークレットを再生成」ウィンドウで、「再生成」をクリックします。
新しいクライアント ID と秘密鍵が発行されます。
- クライアント ID と秘密鍵は、新しいペアを再生成するまで期限切れになりません。
- 資格情報を生成したら、組織のデバイスが配置されているリージョンに基づいて適切な URL を使用します。
- NAEA: https://auth.naea1.uds.lenovo.com
- EU: https://auth.euwe1.uds.lenovo.com
クライアント ID と秘密鍵の新しいペアを生成すると、古いペアは無効になります。
ベアラー・トークンの取得
ベアラー・トークンは、有効期限が 30 分の Auth 2.0 を使用するアクセス・トークンの一種です。新しいアクセス・トークンを取得するには、アプリケーションはこのベアラー・トークンとクライアント ID を認証サーバーに送信する必要があります。この検証プロセスにより、承認されたアプリケーション (ベアラー・トークンが最初に発行されたアプリケーション) のみが新しいアクセス・トークンを要求できるようになります。
- 外部 API を使用して API ベアラー・トークンを生成します。
- URL - ベース URL + /api/v1/auth/<organization_name>/token
- ベース URL は、地域 (NA か EU) によって異なります。
- 本文は x-ww-form-urlencoded で、以下が含まれている必要があります。
- grant_type: client_credentials
- client_secret: シークレット (API 資格情報ページから)
- client_id: id (API 資格情報ページから)
30 分後に有効期限が切れるときに、新しいベアラー・トークンを生成します。
Swagger を使用した API 操作の探索
Swagger 仕様アーカイブには、index.html ファイルとその他の JavaScript ファイルを含むフォルダーが含まれています。
- 各 API の詳細が記載された Swagger 仕様 zip ファイル をダウンロードします。
フォルダー内のファイルを抽出します。
ダブルクリックして index.html を開きます。Swagger に LDO デバイス・インサイト (LDI はレガシーです) API のホーム・ページが表示されます。
- ベアラー・トークンを生成します。
API を試す
Swagger で API メソッドを選択します。
- 呼び出しでベアラー・トークンを使用します。
「試してみる」をクリックします。
API メソッドの例
認証 - API トークン・セッション
Lenovo SDK スナップショット
HTTP 応答
ネガティブ API サンプル: Groovy ACME テスト
HTTP 要求
HTTP 応答