Создание отправки и управление ими
Используйте API отправки Microsoft Store для программного запроса и создания отправки приложений, надстроек и пакетов для учетной записи Центра партнеров вашей организации. Этот API полезен, если ваша учетная запись управляет множеством приложений или надстроек, и вы хотите автоматизировать и оптимизировать процесс отправки для этих ресурсов. Этот API использует Azure Active Directory (Azure AD) для проверки подлинности вызовов из приложения или службы.
Следующие шаги описывают комплексный процесс использования API отправки Microsoft Store:
- Убедитесь, что вы выполнили все предварительные требования.
- Перед вызовом метода в API отправки Microsoft Store получите маркер доступа Azure AD. После получения маркера у вас есть 60 минут для использования этого маркера в вызовах API отправки Microsoft Store до истечения срока действия маркера. После истечения срока действия маркера можно создать новый маркер.
- ВызовИТЕ API отправки Microsoft Store.
Внимание
Если вы используете этот API для создания отправки для приложения, тестового пакета или надстройки, обязательно внесите дальнейшие изменения в отправку только с помощью API, а не в Центре партнеров. Если вы используете Центр партнеров для изменения отправки, созданной с помощью API, вы больше не сможете изменить или зафиксировать эту отправку с помощью API. В некоторых случаях отправка может оставаться в состоянии ошибки, в которой она не может продолжаться в процессе отправки. В этом случае необходимо удалить отправку и создать новую отправку.
Внимание
Этот API нельзя использовать для публикации отправки для покупок томов с помощью Microsoft Store для бизнеса и Microsoft Store для образования или публикации отправки бизнес-приложений непосредственно на предприятия. Для обоих этих сценариев необходимо использовать публикацию отправки в Центре партнеров.
Примечание.
Этот API нельзя использовать с приложениями или надстройками, которые используют обязательные обновления приложений и управляемые Магазином надстройки. Если вы используете API отправки Microsoft Store с приложением или надстройкой, которая использует одну из этих функций, API вернет код ошибки 409. В этом случае необходимо использовать Центр партнеров для управления отправками для приложения или надстройки.
Шаг 1. Выполнение предварительных требований для использования API отправки в Microsoft Store
Прежде чем приступить к написанию кода для вызова API отправки Microsoft Store, убедитесь, что выполнены следующие предварительные требования.
У вас (или вашей организации) должен иметься каталог Azure AD, а также у вас должен быть доступ уровня глобального администратора к этому каталогу. Если вы уже используете Microsoft 365 или другие бизнес-службы Microsoft, у вас уже есть каталог Azure AD. В противном случае вы можете создать Azure AD в Центре партнеров без дополнительной платы.
Необходимо связать приложение Azure AD с учетной записью Центра партнеров и получить идентификатор арендатора, идентификатор и ключ клиента. Эти значения необходимы для получения маркера доступа Azure AD, который будет использоваться в вызовах к API отправки Microsoft Store.
Подготовьте приложение для использования с API отправки в Microsoft Store:
Если приложение еще не существует в Центре партнеров, необходимо создать приложение, зарезервировав его имя в Центре партнеров. Api отправки Microsoft Store нельзя использовать для создания приложения в Центре партнеров; Вы должны работать в Центре партнеров, чтобы создать его, а затем после этого можно использовать API для доступа к приложению и программно создавать для него отправки. Однако api можно использовать для программного создания надстроек и пакетов перед созданием отправки для них.
Прежде чем создать отправку для данного приложения с помощью этого API, необходимо сначала создать одну отправку для приложения в Центре партнеров, включая ответ на анкету о возрастных оценках . После этого вы сможете программно создавать новые отправки для этого приложения с помощью API. Перед использованием API для этих типов отправки не требуется создавать отправку надстройки или отправку тестового пакета.
Если вы создаете или обновляете отправку приложения и необходимо включить пакет приложения, подготовьте пакет приложения.
Если вы создаете или обновляете отправку приложения и вам нужно включить снимки экрана или изображения для описания Магазина, подготовьте снимки экрана и изображения приложения.
Если вы создаете или обновляете отправку надстройки, и вам нужно включить значок, подготовьте значок.
Порядок связывания приложения Azure AD с учетной записью Центра партнеров
Прежде чем использовать API отправки Microsoft Store, необходимо связать приложение Azure AD с учетной записью Центра партнеров, получить идентификатор клиента и идентификатор клиента для приложения и создать ключ. Приложение Azure AD представляет приложение или службу, из которой требуется вызвать API отправки Microsoft Store. Для получения маркера доступа Azure AD, передаваемого в API, необходимы идентификатор арендатора, идентификатор и ключ клиента.
Примечание.
Эту задачу нужно выполнить только один раз. После получения идентификатора арендатора, идентификатора и ключа клиента их можно повторно использовать в любой момент, когда потребуется создать новый маркер доступа Azure AD.
В Центре партнеров свяжите учетную запись Центра партнеров своей организации с каталогом Azure AD организации.
Затем на странице Пользователи в разделе Параметры учетной записи в Центре партнеров добавьте приложение Azure AD, представляющее приложение или службу, которые будут использоваться для доступа к отправкам для учетной записи Центра партнеров. Убедитесь, что этому приложению назначена роль Менеджер. Если приложение еще не существует в каталоге Azure AD, можно создать новое приложение Azure AD в Центре партнеров.
Вернитесь на страницу Пользователи, щелкните имя приложения Azure AD, чтобы перейти к параметрам приложения, и скопируйте идентификатор арендатора и идентификатор клиента.
Щелкните Добавить новый ключ. На следующем экране скопируйте значение в поле Ключ. Покинув эту страницу, вы больше не сможете получить доступ к этим сведениям. Дополнительные сведения см. в разделе Управление ключами для приложения Azure AD.
Шаг 2. Получение маркера доступа Azure AD
Перед вызовом любого из методов в API отправки Microsoft Store необходимо сначала получить маркер доступа Azure AD, который передается в заголовок авторизации каждого метода в 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.
После истечения срока действия маркера доступа можно получить новый, выполнив тот же вызов HTTP.
Примеры, демонстрирующие получение маркера доступа с помощью кода C#, Java или Python, см. в примерах кода API отправки в Microsoft Store.
Шаг 3. Использование API отправки в Microsoft Store
После получения маркера доступа Azure AD можно вызвать методы в API отправки Microsoft Store. API включает множество методов, сгруппированных в сценарии для приложений, надстроек и пакетов. Для создания или обновления отправки обычно вызывается несколько методов в API отправки Microsoft Store в определенном порядке. Сведения о каждом сценарии и синтаксисе каждого метода см. в статьях в следующей таблице.
Примечание.
После получения маркера доступа у вас есть 60 минут для вызова методов в API отправки Microsoft Store до истечения срока действия маркера.
| Сценарий | Description |
|---|---|
| Приложения | Извлеките данные для всех приложений, зарегистрированных в учетной записи Центра партнеров, и создайте отправки для приложений. Дополнительные сведения об этих методах см. в следующих статьях: |
| Надстройки | Получение, создание или удаление надстроек для приложений, а затем получение, создание и удаление отправки для надстроек. Дополнительные сведения об этих методах см. в следующих статьях: |
| Тестовые пакеты | Получение, создание и удаление пакетов для ваших приложений, а затем получение, создание или удаление отправки для пакетов. Дополнительные сведения об этих методах см. в следующих статьях: |
Примеры кода
В следующих статьях приведены подробные примеры кода, демонстрирующие использование API отправки Microsoft Store на нескольких разных языках программирования:
- Пример C#: отправка приложений, надстроек и рейсов
- Пример C#: отправка приложения с параметрами игры и трейлерами
- Пример Java: отправка приложений, надстроек и рейсов
- Пример Java: отправка приложения с параметрами игры и трейлерами
- Пример Python: отправка приложений, надстроек и рейсов
- Пример Python: отправка приложения с параметрами игры и трейлерами
Модуль StoreBroker PowerShell
В качестве альтернативы вызову API отправки Microsoft Store напрямую мы также предоставляем модуль PowerShell с открытым исходным кодом, который реализует интерфейс командной строки на вершине API. Этот модуль называется StoreBroker. Этот модуль можно использовать для управления отправкой приложений, полетов и надстроек из командной строки, а не вызова API отправки Microsoft Store напрямую, или вы можете просто просмотреть источник, чтобы просмотреть дополнительные примеры вызова этого API. Модуль StoreBroker активно используется в Корпорации Майкрософт в качестве основного способа отправки многих сторонних приложений в Магазин.
Дополнительные сведения см . на странице StoreBroker на сайте GitHub.
Устранение неполадок
| Проблема | Решение |
|---|---|
| После вызова API отправки Microsoft Store из PowerShell данные ответа для API повреждены при преобразовании его из формата JSON в объект PowerShell с помощью командлета ConvertFrom-Json , а затем обратно в формат JSON с помощью командлета ConvertTo-Json . | По умолчанию параметр -Depth для командлета ConvertTo-Json имеет значение 2 уровня объектов, что слишком неглубоко для большинства объектов JSON, возвращаемых API отправки Microsoft Store. При вызове командлета ConvertTo-Json задайте для параметра -Depth большее число, например 20. |
Дополнительная информация
Если у вас есть вопросы об API отправки Microsoft Store или вам нужна помощь по управлению отправками с помощью этого API, используйте следующие ресурсы:
- Задайте свои вопросы на наших форумах.
- Посетите страницу поддержки и попросите один из вариантов поддержки центра партнеров. Если вам будет предложено выбрать тип проблемы и категорию, выберите "Отправка приложения" и "Сертификация " и "Отправка приложения" соответственно.