API панели мониторинга оборудования

Используйте API оборудования Майкрософт для программного запроса и создания отправок для аппаратных продуктов в учетной записи Центра партнеров вашей организации. Эти API полезны, если ваша учетная запись управляет многими продуктами, и вы хотите автоматизировать и оптимизировать процесс отправки для этих ресурсов. Эти API используют идентификатор Microsoft Entra (идентификатор Microsoft Entra) для проверки подлинности вызовов из приложения или службы. Ниже описан комплексный процесс использования API оборудования Майкрософт.

1. Эти API могут использоваться только учетными записями, принадлежащими к программе Центра партнеров по оборудованию.

2. Убедитесь, что выполнены указанные ниже предварительные требования.

3. Прежде чем вызывать метод в API оборудования Майкрософт, получите маркер доступа Microsoft Entra ID, как показано ниже. После получения маркера доступа у вас будет 60 минут, чтобы использовать его в вызовах к API отправки Microsoft Store до окончания срока действия маркера. После истечения срока действия маркера можно сформировать новый маркер.

4. Вызовите API оборудования Майкрософт.

Выполните предварительные требования для использования API оборудования Майкрософт

Прежде чем приступать к написанию кода для вызова API оборудования Майкрософт, убедитесь, что выполнены следующие необходимые предварительные требования.

• У вас (или вашей организации) должен быть каталог идентификатора Microsoft Entra и разрешение на глобальный администратор для каталога. Если вы уже используете Microsoft 365 или другие бизнес-службы корпорации Майкрософт, у вас уже есть каталог идентификаторов Microsoft Entra. В противном случае вы можете создать новый идентификатор Microsoft Entra в Центре партнеров без дополнительной платы.

• Если приложение идентификатора Microsoft Entra еще не существует, его необходимо создать.

• Необходимо связать приложение с идентификатором Microsoft Entra с учетной записью Центра партнеров и назначить ему роль Менеджера.

• Соберите идентификатор клиента, идентификатор клиента и ключ приложения Microsoft Entra. Не забудьте распечатать или скопировать эти сведения о ключе, так как вы не сможете снова получить к ним доступ после того, как покинете страницу создания ключа.

Назначение соответствующих ролей оборудования приложению Microsoft Entra ID

После выполнения описанных выше предварительных требований необходимо назначить соответствующие роли, чтобы приложение Microsoft Entra ID могло создавать отправки и этикетки доставки и управлять ими.

1. В Центре партнеров щелкните значок шестеренки (в правом верхнем углу панели мониторинга), а затем выберите Параметры разработчика. В меню Параметры выберите Пользователи.

2. На странице Пользователи выберите Microsoft Entra приложения идентификаторов и приложение идентификатора Microsoft Entra, представляющее приложение или службу, которые будут использоваться для доступа к отправке для вашей учетной записи Центра партнеров.

3. На этой странице в разделе Роли выберите Оборудование.

   

   Выберите Driver Submitter (Отправитель драйверов), Shipping Label owner (Владелец метки доставки) и (если доступно) — Shipping Label promoter (Продвигатель метки доставки). Дополнительные сведения об этих ролях

Получение маркера доступа Microsoft Entra ID

Перед вызовом любого из методов в API оборудования Майкрософт необходимо сначала получить маркер доступа Microsoft Entra ID, который передается в заголовок Authorization каждого метода в 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

Для значения tenant_id в URI POST, а также параметров client_id и client_secret укажите идентификатор клиента, идентификатор клиента и ключ для приложения, полученные из Центра партнеров в предыдущем разделе. Для параметра resource укажите значение https://manage.devcenter.microsoft.com.

После истечения срока действия маркера доступа его можно обновить, следуя инструкциям в разделе Обновление маркеров доступа.

Использование API оборудования Майкрософт

Получив маркер доступа Microsoft Entra ID, можно вызывать методы в API оборудования Майкрософт. API включает множество методов, сгруппированных по сценариям. Для создания или обновления отправок обычно вызывается несколько методов в API оборудования Майкрософт в определенном порядке. Сведения о каждом сценарии и синтаксисе каждого метода см. в статьях, приведенных в следующей таблице.

Сценарий	Описание
драйверы,	Получение, создание и обновление драйверов, зарегистрированных в учетной записи Центра партнеров. Дополнительные сведения об этих методах см. в следующих статьях. Получение данных о продукте Управление отправками продуктов Получение данных о этикетке доставки Управление этикетками доставки

Примеры кода

В следующем примере приведен подробный код, демонстрирующий использование API оборудования Майкрософт вместе с комплексным готовым решением, созданным командой Microsoft Surface и устройств.

• Пример на языке C#

Примеры API панели мониторинга оборудования (GitHub)

Средство Surface Dev Center Manager (GitHub)

Дополнительная справка

Если у вас есть вопросы об API отправки Microsoft Store или вам нужна помощь в управлении отправками с помощью этого API, посетите страницу поддержки и запросите справку.

Связанные темы

Что такое идентификатор Microsoft Entra?