Создание и управление отправками
Используйте 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. В этом случае необходимо использовать Центр партнеров для управления отправками приложений или дополнений.
Заметка
Этот API нельзя использовать с приложениями или надстройками, которые находятся в ценовой версии 2. Продукт находится в версии ценообразования 2, если на странице Цены и доступность в разделе Цены есть кнопка Просмотр цен по рынкам. Если вы используете API отправки Microsoft Store с приложением или надстройкой, которая использует версию ценообразования 2, то API вернет неизвестный уровень в части, связанной с ценообразованием. Вы можете продолжать использовать этот API для обновления модулей, отличных от ценообразования и доступности.
Шаг 1. Выполнение предварительных требований для использования API отправки в Microsoft Store
Прежде чем приступить к написанию кода для вызова API отправки Microsoft Store, убедитесь, что выполнены следующие предварительные требования.
У вас (или вашей организации) должен быть каталог Azure AD, и у вас должно быть разрешение глобального администратора для каталога. Если вы уже используете Microsoft 365 или другие бизнес-службы от Майкрософт, у вас уже есть каталог 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.
Чтобы получить маркер доступа, следуйте инструкциям в статье Service to Service Calls Using Client Credentials для отправки 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 укажите идентификатор арендатора, идентификатор клиента, а также ключ для вашего приложения, который вы получили из Центра партнеров в предыдущем разделе. Для параметра ресурса необходимо указать 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, прежде чем срок действия маркера истечет.
| Сценарий | Описание |
|---|---|
| Приложения | Извлеките данные о всех приложениях, зарегистрированных на вашей учетной записи Центра партнеров, и создайте публикации для приложений. Дополнительные сведения об этих методах см. в следующих статьях: |
| Надстройки | Получение, создание или удаление надстроек для приложений, а затем получение, создание и удаление отправки для надстроек. Дополнительные сведения об этих методах см. в следующих статьях: |
| Рейсы по пакетам | Получение, создание и удаление пакетов для ваших приложений, а затем получение, создание или удаление отправки для пакетов. Дополнительные сведения об этих методах см. в следующих статьях: |
Примеры кода
В следующих статьях приведены подробные примеры кода, демонстрирующие использование 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, используйте следующие ресурсы:
- Задайте вопросы на наших форумах .
- Посетите страницу поддержки и запросите один из предложенных вариантов помощи для Центра партнеров. Если вам будет предложено выбрать тип проблемы и категорию, выберите отправку приложений и сертификацию и отправку приложениясоответственно.