Создание отправок и управление ими

  • Статья

Используйте API отправки Microsoft Store для программного запроса и создания отправок для приложений, надстроек и тестовых пакетов для учетной записи Центра партнеров вашей или вашей организации. Этот API-интерфейс удобно использовать, если под вашей учетной записью выполняется управление большим количеством приложений или надстроек и вам необходимо оптимизировать процесс отправки для этих ресурсов. Для проверки подлинности вызовов из приложения или службы в этом интерфейсе используется служба Azure Active Directory (Azure AD).

Ниже приведен список всех действий, которые необходимо выполнить, чтобы начать работу с API отправки Microsoft Store.

  1. Убедитесь, что вы выполнили все необходимые условия.
  2. Перед вызовом метода в API отправки Microsoft Store получите маркер доступа Azure AD. После получения маркера доступа у вас будет 60 минут, чтобы использовать его в вызовах к API отправки Microsoft Store до окончания срока действия маркера. После истечения срока действия маркера можно сформировать новый маркер.
  3. Вызовите API отправки Microsoft Store.

Важно!

Если вы используете этот API для создания отправки для приложения, тестового пакета или надстройки, не забудьте внести дальнейшие изменения в отправку только с помощью API, а не в Центре партнеров. Если вы используете Центр партнеров для изменения отправки, изначально созданной с помощью API, вы больше не сможете изменить или зафиксировать эту отправку с помощью API. В некоторых случаях отправка может оставаться в состоянии ошибки, когда продолжить процесс отправки невозможно. В этом случае необходимо удалить отправку и создать новую.

Важно!

Этот API нельзя использовать для публикации отправок для покупок в больших объемах через Microsoft Store для бизнеса и Microsoft Store для образования и для публикации отправок бизнес-приложений непосредственно для предприятий. В обоих случаях необходимо использовать публикацию отправки в Центре партнеров.

Примечание

Этот API не может использоваться с приложениями или надстройками, использующими обязательные обновления приложений и управляемые Store потребляемые надстройки. Если вы используете 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.

  1. В Центре партнеров свяжите учетную запись Центра партнеров своей организации с каталогом Azure AD организации.

  2. Затем на странице Пользователи в разделе Параметры учетной записи в Центре партнеров добавьте приложение Azure AD, представляющее приложение или службу, которые будут использоваться для доступа к отправкам для учетной записи Центра партнеров. Убедитесь, что этому приложению назначена роль Менеджер. Если приложение еще не существует в каталоге Azure AD, можно создать новое приложение Azure AD в Центре партнеров.

  3. Вернитесь на страницу Пользователи, щелкните имя приложения Azure AD, чтобы перейти к параметрам приложения, и скопируйте идентификатор арендатора и идентификатор клиента.

  4. Щелкните Добавить новый ключ. На следующем экране скопируйте значение в поле Ключ. Покинув эту страницу, вы больше не сможете получить доступ к этим сведениям. Дополнительные сведения см. в разделе Управление ключами для приложения 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 до окончания срока действия маркера.

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

Примеры кода

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

Модуль StoreBroker PowerShell

В качестве альтернативы прямому вызову API отправки в Microsoft Store также предоставляется модуль PowerShell с открытым исходным кодом, в котором поверх API реализован интерфейс командной строки. Этот модуль называется StoreBroker. Этот модуль можно использовать для управления приложением, тестируемой возможностью и отправками надстроек из командной строки, вместо того чтобы вызывать API отправки в Microsoft Store напрямую. Кроме того, можно просмотреть дополнительные примеры вызова этого API, изучив исходный код. Модуль StoreBroker активно используется Microsoft в качестве основного способа отправки многих собственных приложений компании в Магазин.

Дополнительные сведения см. на нашей странице 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, используйте следующие веб-ресурсы.

  • Задайте вопрос на наших форумах.
  • Посетите нашу страницу поддержки и запросите один из вариантов поддержки для Центра партнеров. Если вам будет предложено выбрать тип проблемы и категорию, выберите Отправка и сертификация приложения и Отправка приложения соответственно.