ハードウェア ダッシュボード API

  • [アーティクル]

組織のパートナー センター アカウント内でハードウェア製品の申請をプログラムで照会したり、作成したりするには、Microsoft Hardware API を使用します。 これらの API は、アカウントで多数の製品を管理しており、これらのアセットの送信プロセスを自動化および最適化したい場合に役立ちます。 これらの API は、Microsoft Entra ID (Microsoft Entra ID) を使用して、アプリまたはサービスからの呼び出しを認証します。 次の手順では、Microsoft Hardware API を使用するエンドツーエンドのプロセスについて説明します。

  1. これらの API は、ハードウェア パートナー センター プログラムに参加しているアカウントでのみ使用できます。

  2. 以下の前提条件を満たしていることを確認してください。

  3. 次に示すように、Microsoft ハードウェア API でメソッドを呼び出す前に、Microsoft Entra ID アクセス トークンを取得します。 トークンを取得した後、Microsoft Store 申請 API の呼び出しでこのトークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れた後は、新しいトークンを生成できます。

  4. Microsoft ハードウェア API を呼び出します。

Microsoft ハードウェア API を使うための前提条件を満たす

Microsoft ハードウェア API を呼び出すコードの作成を開始する前に、次の必須の前提条件を満たしていることを確認します。

Microsoft Entra IDアプリケーションへの適切なハードウェアの役割の割り当て

上記の前提条件を完了したら、Microsoft Entra IDアプリケーションが申請と配送先住所ラベルを作成および管理できるように、適切なロールを割り当てる必要があります。

  1. パートナー センターで、歯車アイコン (ダッシュボードの右上隅の近く) を選択し、[開発者向け設定] を選択します。 [設定] メニューで [ユーザー] を選択します。

  2. ユーザー ページで、Microsoft Entra IDアプリケーション と、パートナー センター アカウントの申請にアクセスするために使用するアプリまたはサービスを表す [Microsoft Entra IDアプリケーション] を選択します 。

  3. このページで、[Roles]\(役割\) の下の [ハードウェア] を選択します。

    an image showing the Hardware tab in the Roles section.

    [Driver Submitter]\(ドライバーの送信者\)、[Shipping Label owner]\(配送先住所ラベルの所有者\)、(使用できる場合は) [Shipping Label promoter]\(配送先住所ラベルのプロモーター\) を選択します。 これらのロールに関する詳細情報

Microsoft Entra IDアクセス トークンを取得する

Microsoft Hardware API のメソッドを呼び出す前に、まず Microsoft Entra ID アクセス トークンを取得し、API の各メソッドの 認可 ヘッダーに渡す必要があります。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れた後は トークンを更新してそれ以降の API 呼び出しで引き続き使用できます。 アクセス トークンを取得するには、「クライアント資格情報を使用したサービス間の呼び出し」の手順に従って、HTTP POST を https://login.microsoftonline.com/<tenant_id>/oauth2/token エンドポイントに送信します。 要求の例を次に示します。

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

POST URI の tenant_id の値と client_id および client_secret のパラメーターには、前のセクションでパートナー センターから取得したアプリケーションのテナント ID、クライアント ID、キーを指定します。 resource パラメーターには、https://manage.devcenter.microsoft.com を指定します。

アクセストークンの有効期限が切れたら アクセストークン の更新 の手順に従って更新できます。

Microsoft ハードウェア API を使用する

Microsoft Entra ID アクセス トークンを取得したら、Microsoft ハードウェア API でメソッドを呼び出すことができます。 API には、アプリのシナリオにグループ化された多くのメソッドが含まれています。 送信を作成または更新するには、通常、Microsoft Hardware API の複数のメソッドを特定の順序で呼び出します。 各シナリオと各メソッドの構文の詳細については、次の表の記事を参照してください。

シナリオ 説明
ドライバー パートナー センター アカウントに登録されているドライバーを取得、作成、更新します。 これらの方法の詳細については、次の記事を参照してください。

コード例

次のサンプルは、Microsoft Surface and Devices チームによって作成された完全なエンド ツー エンドの構築済みソリューションと共に Microsoft Hardware API を使用する方法を示す詳細なコードとして利用できます。

ハードウェア ダッシュボード API のサンプル (GitHub)

Surface Dev Center Manager ツール (GitHub)

追加のヘルプ

Microsoft Store 申請 API について質問がある場合や、この API を使った申請の管理に関してサポートが必要な場合は、サポート ページにアクセスしてサポートを要求してください。

Microsoft Entra Connect とは