API аппаратной панели мониторинга
Используйте API оборудования Майкрософт для программного запроса и создания отправки для аппаратных продуктов в учетной записи Центра партнеров вашей организации. Эти API полезны, если ваша учетная запись управляет множеством продуктов, и вы хотите автоматизировать и оптимизировать процесс отправки для этих ресурсов. Эти API используют идентификатор Microsoft Entra (Идентификатор Microsoft Entra) для проверки подлинности вызовов из приложения или службы. В следующих шагах описывается комплексный процесс использования API оборудования Майкрософт:
Эти API могут использоваться только учетными записями, принадлежащими программе Центра партнеров оборудования.
Убедитесь, что выполнены указанные ниже предварительные требования.
Перед вызовом метода в API оборудования Майкрософт получите маркер доступа к идентификатору Microsoft Entra, как показано ниже. После получения маркера у вас есть 60 минут для использования этого маркера в вызовах API отправки Microsoft Store до истечения срока действия маркера. После истечения срока действия маркера можно создать новый маркер.
Вызовите API оборудования Майкрософт.
Выполните необходимые условия для использования API оборудования Майкрософт
Прежде чем приступить к написанию кода для вызова API оборудования Майкрософт, убедитесь, что выполнены следующие необходимые предварительные требования.
У вас (или вашей организации) должен быть каталог идентификатора Microsoft Entra, и у вас должно быть разрешение глобального администратора для каталога. Если вы уже используете Microsoft 365 или другие бизнес-службы от Майкрософт, у вас уже есть каталог идентификатора Microsoft Entra. В противном случае вы можете создать новый идентификатор Microsoft Entra в Центре партнеров без дополнительной платы.
Если приложение идентификатора Microsoft Entra еще не существует, необходимо создать его.
Необходимо связать приложение Идентификатора Microsoft Entra с учетной записью Центра партнеров и назначить ей роль руководителя.
Соберите идентификатор клиента приложения Microsoft Entra ID, идентификатор клиента и ключ. Не забудьте распечатать или скопировать эту информацию, так как вы не сможете получить доступ к ней еще раз после выхода страницы создания ключа.
Назначение соответствующих ролей оборудования приложению идентификатора Microsoft Entra
После завершения указанных выше предварительных требований необходимо назначить соответствующие роли, чтобы приложение идентификатора Microsoft Entra могло создавать и управлять отправками и метками доставки.
В Центре партнеров выберите значок шестеренки (в правом верхнем углу панели мониторинга) и выберите параметры разработчика. В меню "Параметры" выберите "Пользователи".
На странице "Пользователи" выберите приложения Microsoft Entra ID и приложение Microsoft Entra ID, представляющее приложение или службу, которую вы будете использовать для доступа к отправке для учетной записи Центра партнеров.
На этой странице в разделе "Роли" выберите "Оборудование".
Выберите "Отправитель драйверов", владелец метки доставки и, если он доступен, промоутер меток доставки. Дополнительные сведения об этих ролях
Получение маркера доступа идентификатора Microsoft Entra
Прежде чем вызывать любой из методов в API оборудования Майкрософт, необходимо сначала получить маркер доступа идентификатора Microsoft Entra, который передается в заголовок авторизации каждого метода в 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 можно вызвать методы в API оборудования Майкрософт. API включает множество методов, сгруппированных в сценарии. Для создания или обновления отправки обычно вызывается несколько методов в API оборудования Майкрософт в определенном порядке. Сведения о каждом сценарии и синтаксисе каждого метода см. в статьях в следующей таблице.
| Сценарий | Description |
|---|---|
| Драйверы | Получите, создайте и обновите драйверы, зарегистрированные в учетной записи Центра партнеров. Дополнительные сведения об этих методах см. в следующих статьях: |
Примеры кода
В следующем примере представлен подробный код, демонстрирующий использование API оборудования Майкрософт, а также полное завершение предварительно созданного решения, созданного командой Microsoft Surface и устройств:
- Примеры API панели мониторинга оборудования (GitHub)
- Средство Surface Центр разработки Manager (GitHub)
Дополнительная информация
Если у вас есть вопросы об API отправки Microsoft Store или вам нужна помощь по управлению отправками с помощью этого API, посетите страницу поддержки и запрос справки.