硬件仪表板 API

  • 项目

使用“Microsoft 硬件 API”以编程方式在组织的合作伙伴中心帐户中查询和创建硬件产品提交。 如果你的帐户管理多个产品，并且你想要自动执行并优化这些资源的提交过程，那么这些 API 非常有用。 这些 API 使用 Microsoft Entra ID（Microsoft Entra ID）对来自应用或服务的调用进行身份验证。 以下步骤介绍了使用“Microsoft 硬件 API”的端到端过程：

  1. 这些 API 仅可供属于硬件合作伙伴中心计划的帐户使用。

  2. 确保已完成以下先决条件。

  3. 在 Microsoft 硬件 API 中调用方法之前，请获取 Microsoft Entra ID 访问令牌，如下所示。 获取令牌后，可以在 60 分钟的令牌有效期内，使用该令牌调用“Microsoft Store 提交 API”。 该令牌到期后，可以重新生成一个。

  4. 调用“Microsoft 硬件 API”。

完成使用“Microsoft 硬件 API”的先决条件

在开始编写调用“Microsoft 硬件 API”的代码之前，确保已满足以下必需的先决条件。

将适当的硬件角色分配给 Microsoft Entra ID 应用程序

完成上述先决条件后，我们现在必须分配相应的角色，以便 Microsoft Entra ID 应用程序可以创建和管理提交和发货标签。

  1. 请从合作伙伴中心选择齿轮图标（靠近仪表板右上角），然后选择“开发人员设置”。 在“设置”菜单中，选择“用户”。

  2. 在 “用户 ”页上，选择 Microsoft Entra ID 应用程序和 Microsoft Entra ID 应用程序，该应用程序代表将用于访问合作伙伴中心帐户提交的应用或服务。

  3. 在此页面上的“角色”下，选择“硬件”。

    an image showing the Hardware tab in the Roles section.

    选择“驱动程序提交者”、“发货标签所有者”，以及“发货标签推广者”（如果可用）。 详细了解这些角色

获取 Microsoft Entra ID 访问令牌

在调用 Microsoft 硬件 API 中的任何方法之前，必须先获取传递到 API 中每个方法的授权 标头的 Microsoft Entra ID 访问令牌。 获取访问令牌后，在它到期前，你有 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 硬件 API”中按特定顺序调用多个方法。 有关每个方案以及每个方法的语法的信息，请参阅下表中的文章。

场景 说明
驱动程序 获取、创建和更新向你的合作伙伴中心帐户注册的驱动程序。 有关这些方法的详细信息，请参阅以下文章：

代码示例

以下示例提供了详细的代码，演示如何结合 Microsoft Surface 和设备团队创建的完整端到端预生成解决方案使用 Microsoft 硬件 API：

硬件仪表板 API 示例 (GitHub)

Surface 开发人员中心管理器工具 (GitHub)

其他帮助

如果你对“Microsoft Store 提交 API”有疑问，或需要获取有关使用此 API 来管理提交的帮助，请访问支持页面并请求帮助。

什么是 Microsoft Entra ID？