Criar e gerenciar enviosCreate and manage submissions

Use a API de envio de Microsoft Store para consultar e criar programaticamente os envios de aplicativos, Complementos e vôos de pacote para sua conta do centro de parceiros da sua organização.Use the Microsoft Store submission API to programmatically query and create submissions for apps, add-ons and package flights for your or your organization's Partner Center account. Essa API será útil se sua conta gerenciar muitos aplicativos ou complementos e você quiser automatizar e otimizar o processo de envio para esses ativos.This API is useful if your account manages many apps or add-ons, and you want to automate and optimize the submission process for these assets. Essa API usa o Active Directory do Azure (Azure AD) para autenticar as chamadas do seu aplicativo ou serviço.This API uses Azure Active Directory (Azure AD) to authenticate the calls from your app or service.

As etapas a seguir descrevem o processo completo de usar a API de envio da Microsoft Store:The following steps describe the end-to-end process of using the Microsoft Store submission API:

  1. Certifique-se de que você tenha concluído todos os pré-requisitos.Make sure that you have completed all the prerequisites.
  2. Antes de chamar um método na API de envio da Microsoft Store obtenha um token de acesso do Azure AD.Before you call a method in the Microsoft Store submission API, obtain an Azure AD access token. Depois de obter um token, você tem 60 minutos para usá-lo em chamadas para a API de envio da Microsoft Store antes que ele expire.After you obtain a token, you have 60 minutes to use this token in calls to the Microsoft Store submission API before the token expires. Depois que o token expirar, será possível gerar um novo.After the token expires, you can generate a new token.
  3. Chame a API de envio da Microsoft Store.Call the Microsoft Store submission API.

Importante

Se você usar essa API para criar um envio para um aplicativo, um vôo de pacote ou um complemento, certifique-se de fazer outras alterações no envio somente usando a API, em vez de no Partner Center.If you use this API to create a submission for an app, package flight, or add-on, be sure to make further changes to the submission only by using the API, rather than in Partner Center. Se você usar o Partner Center para alterar um envio originalmente criado usando a API, não será mais possível alterar ou confirmar esse envio usando a API.If you use Partner Center to change a submission that you originally created by using the API, you will no longer be able to change or commit that submission by using the API. Em alguns casos, o envio pode ficar em um estado de erro em que ele não pode continuar no processo de envio.In some cases, the submission could be left in an error state where it cannot proceed in the submission process. Se isso ocorrer, você deve excluir o envio e criar um novo.If this occurs, you must delete the submission and create a new submission.

Importante

Você não pode usar essa API para publicar os envios de compras de volume por meio da Microsoft Store para Empresas e da Microsoft Store para Educação ou publicar os envios de aplicativos LOB diretamente para empresas.You cannot use this API to publish submissions for volume purchases through the Microsoft Store for Business and Microsoft Store for Education or to publish submissions for LOB apps directly to enterprises. Para ambos os cenários, você deve usar publicar o envio no Partner Center.For both of these scenarios, you must use publish the submission in Partner Center.

Observação

Essa API não pode ser usada com apps ou complementos que usem atualizações de app obrigatórias e complementos consumíveis gerenciados pela Store.This API cannot be used with apps or add-ons that use mandatory app updates and Store-managed consumable add-ons. Se você usar a API de envio da Microsoft Store com um aplicativo ou um complemento que usa um desses recursos, a API retornará um código de erro 409.If you use the Microsoft Store submission API with an app or add-on that uses one of these features, the API will return a 409 error code. Nesse caso, você deve usar o Partner Center para gerenciar os envios para o aplicativo ou complemento.In this case, you must use Partner Center to manage the submissions for the app or add-on.

Etapa 1: Concluir os pré-requisitos para usar a API de envio da Microsoft StoreStep 1: Complete prerequisites for using the Microsoft Store submission API

Antes de começar a escrever o código para chamar a API de envio da Microsoft Store, certifique-se de que você concluiu os pré-requisitos a seguir.Before you start writing code to call the Microsoft Store submission API, make sure that you have completed the following prerequisites.

  • Você (ou sua organização) deve ter um diretório do Azure AD e você deve ter permissão de Administrador global para o diretório.You (or your organization) must have an Azure AD directory and you must have Global administrator permission for the directory. Se você já usa Microsoft 365 ou outros serviços corporativos da Microsoft, você já tem o diretório do Azure AD.If you already use Microsoft 365 or other business services from Microsoft, you already have Azure AD directory. Caso contrário, você pode criar um novo Azure AD no Partner Center sem custo adicional.Otherwise, you can create a new Azure AD in Partner Center for no additional charge.

  • Associe um aplicativo do Azure AD à sua conta do Partner Center e obtenha a ID do locatário, a ID do cliente e a chave.You must associate an Azure AD application with your Partner Center account and obtain your tenant ID, client ID and key. Esses valores são necessários para obter um token de acesso do Azure AD, que será usado em chamadas para a API de envio da Microsoft Store.You need these values to obtain an Azure AD access token, which you will use in calls to the Microsoft Store submission API.

  • Prepare seu aplicativo para uso com a API de envio da Microsoft Store:Prepare your app for use with the Microsoft Store submission API:

    • Se seu aplicativo ainda não existir no Partner Center, você deverá criar seu aplicativo reservando seu nome no Partner Center.If your app does not yet exist in Partner Center, you must create your app by reserving its name in Partner Center. Você não pode usar a API de envio de Microsoft Store para criar um aplicativo no Partner Center; Você deve trabalhar no Partner Center para criá-lo e, depois disso, pode usar a API para acessar o aplicativo e criar programaticamente envios para ele.You cannot use the Microsoft Store submission API to create an app in Partner Center; you must work in Partner Center to create it, and then after that you can use the API to access the app and programmatically create submissions for it. No entanto, você pode usar a API para criar complementos e pacotes de pré-lançamento programaticamente antes de criar envios para eles.However, you can use the API to programmatically create add-ons and package flights before you create submissions for them.

    • Antes de criar um envio para um determinado aplicativo usando essa API, você deve primeiro criar um envio para o aplicativo no Partner Center, incluindo responder ao questionário de classificações etárias .Before you can create a submission for a given app using this API, you must first create one submission for the app in Partner Center, including answering the age ratings questionnaire. Depois que você fizer isso, você poderá criar novos envios para este aplicativo usando a API programaticamente.After you do this, you will be able to programmatically create new submissions for this app using the API. Você não precisa criar um envio de complemento nem o envio de versão de pré-lançamento do pacote antes de usar a API para esses tipos de envios.You do not need to create an add-on submission or package flight submission before using the API for those types of submissions.

    • Se você estiver criando ou atualizando um envio de aplicativo e você precisar incluir um pacote do aplicativo, prepare o pacote do aplicativo.If you are creating or updating an app submission and you need to include an app package, prepare the app package.

    • Se você estiver criando ou atualizando um envio de aplicativo e você precisar incluir capturas de tela ou imagens para a listagem da Store, prepare as imagens e capturas de tela do aplicativo.If you are creating or updating an app submission and you need to include screenshots or images for the Store listing, prepare the app screenshots and images.

    • Se você estiver criando ou atualizando um envio de complemento e você precisar incluir um ícone, prepare o ícone.If you are creating or updating an add-on submission and you need to include an icon, prepare the icon.

Como associar um aplicativo do Azure AD à sua conta do Partner CenterHow to associate an Azure AD application with your Partner Center account

Antes de usar a API de envio do Microsoft Store, você deve associar um aplicativo do Azure AD à sua conta do Partner Center, recuperar a ID do locatário e a ID do cliente para o aplicativo e gerar uma chave.Before you can use the Microsoft Store submission API, you must associate an Azure AD application with your Partner Center account, retrieve the tenant ID and client ID for the application and generate a key. O aplicativo do Azure AD representa o aplicativo ou serviço do qual você quer chamar a API de envio da Microsoft Store.The Azure AD application represents the app or service from which you want to call the Microsoft Store submission API. Você precisa da ID do locatário, da ID do cliente e da chave para obter um token de acesso do Azure AD que é passado para a API.You need the tenant ID, client ID and key to obtain an Azure AD access token that you pass to the API.

Observação

Você só precisa executar essa tarefa uma vez.You only need to perform this task one time. Depois de obter a ID do locatário, a ID do cliente e a chave, você poderá reutilizá-las sempre que precisar criar um novo token de acesso do Azure AD.After you have the tenant ID, client ID and key, you can reuse them any time you need to create a new Azure AD access token.

  1. No Partner Center, associe a conta do Partner Center da sua organização ao diretório do Azure AD da sua organização.In Partner Center, associate your organization's Partner Center account with your organization's Azure AD directory.

  2. Em seguida, na página Usuários na seção Configurações da conta do Partner Center, adicione o aplicativo do Azure AD que representa o aplicativo ou serviço que você usará para acessar os envios para sua conta do Partner Center.Next, from the Users page in the Account settings section of Partner Center, add the Azure AD application that represents the app or service that you will use to access submissions for your Partner Center account. Lembre-se de atribuir esse aplicativo à função de Gerenciador.Make sure you assign this application the Manager role. Se o aplicativo ainda não existir no diretório do Azure AD, crie um novo aplicativo do Azure AD no Partner Center.If the application doesn't exist yet in your Azure AD directory, you can create a new Azure AD application in Partner Center.

  3. Retorne à página Usuários, clique no nome do seu aplicativo do Azure AD para acessar as configurações do aplicativo e copie os valores de ID do Locatário e ID do Cliente.Return to the Users page, click the name of your Azure AD application to go to the application settings, and copy down the Tenant ID and Client ID values.

  4. Clique em Adicionar nova chave.Click Add new key. Na tela a seguir, copie o valor da Chave.On the following screen, copy down the Key value. Você não poderá acessar essas informações novamente depois de sair da página.You won't be able to access this info again after you leave this page. Para saber mais, veja Gerenciar chaves de um aplicativo do Azure AD.For more information, see Manage keys for an Azure AD application.

Etapa 2: Obtenção de um token de acesso do Azure ADStep 2: Obtain an Azure AD access token

Antes de chamar qualquer um dos métodos na API de envio da Microsoft Store, primeiro você deve obter um token de acesso do Azure AD que você passa para o cabeçalho Authorization de cada método na API.Before you call any of the methods in the Microsoft Store submission API, you must first obtain an Azure AD access token that you pass to the Authorization header of each method in the API. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar.After you obtain an access token, you have 60 minutes to use it before it expires. Depois que o token expirar, você poderá atualizar o token para que você possa continuar a usá-lo em outras chamadas à API.After the token expires, you can refresh the token so you can continue to use it in further calls to the API.

Para obter o token de acesso, siga as instruções em Chamadas de serviço a serviço usando credenciais do cliente para enviar um HTTP POST para o ponto de extremidade https://login.microsoftonline.com/<tenant_id>/oauth2/token.To obtain the access token, follow the instructions in Service to Service Calls Using Client Credentials to send an HTTP POST to the https://login.microsoftonline.com/<tenant_id>/oauth2/token endpoint. Aqui está um exemplo de solicitação.Here is a sample request.

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

Para o valor da * _ ID de locatário* no URI de postagem e os parâmetros de * _ ID do cliente* e * _ segredo do cliente* , especifique a ID do locatário, a ID do cliente e a chave do aplicativo que você recuperou do Partner Center na seção anterior.For the tenant_id value in the POST URI and the client_id and client_secret parameters, specify the tenant ID, client ID and the key for your application that you retrieved from Partner Center in the previous section. Para o parâmetro resource, especifique https://manage.devcenter.microsoft.com.For the resource parameter, you must specify https://manage.devcenter.microsoft.com.

Depois que seu token de acesso expirar, você poderá atualizá-lo seguindo as instruções descritas aqui.After your access token expires, you can refresh it by following the instructions here.

Para obter exemplos que demonstram como obter um token de acesso usado código C#, Java ou Python, consulte os exemplos de código da API de envio da Microsoft Store.For examples that demonstrate how to obtain an access token by using C#, Java, or Python code, see the Microsoft Store submission API code examples.

Etapa 3: Uso da API de envio da Microsoft StoreStep 3: Use the Microsoft Store submission API

Depois que tiver um token de acesso do Azure AD, você poderá chamar métodos na API de envio da Microsoft Store.After you have an Azure AD access token, you can call methods in the Microsoft Store submission API. A API inclui muitos métodos que são agrupados em cenários de aplicativos, complementos e pacotes de pré-lançamento.The API includes many methods that are grouped into scenarios for apps, add-ons, and package flights. Para criar ou atualizar os envios, você normalmente chama vários métodos na API de envio da Microsoft Store em uma ordem específica.To create or update submissions, you typically call multiple methods in the Microsoft Store submission API in a specific order. Para obter informações sobre cada cenário e a sintaxe de cada método, consulte os artigos na tabela a seguir.For information about each scenario and the syntax of each method, see the articles in the following table.

Observação

Depois de obter um token de acesso, você tem 60 minutos para chamar métodos na API de envio da Microsoft Store antes que o token expire.After you obtain an access token, you have 60 minutes to call methods in the Microsoft Store submission API before the token expires.

CenárioScenario DescriçãoDescription
AplicativosApps Recupere dados para todos os aplicativos que estão registrados em sua conta do Partner Center e crie envios para aplicativos.Retrieve data for all the apps that are registered to your Partner Center account and create submissions for apps. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:For more information about these methods, see the following articles:
ComplementosAdd-ons Obtenha, crie ou exclua complementos para seus aplicativos e, em seguida, obtenha, crie ou exclua os envios dos complementos.Get, create, or delete add-ons for your apps, and then get, create, or delete submissions for the add-ons. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:For more information about these methods, see the following articles:
Pacotes de pré-lançamentoPackage flights Obtenha, crie ou exclua pacotes de pré-lançamento para seus aplicativos e, em seguida, obtenha, crie ou exclua os envios de pacotes de pré-lançamento.Get, create, or delete package flights for your apps, and then get, create, or delete submissions for the package flights. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:For more information about these methods, see the following articles:

Exemplos de códigoCode examples

Os artigos a seguir fornecem exemplos detalhados de código que demonstram como usar a API de envio da Microsoft Store em várias linguagens de programação diferentes:The following articles provide detailed code examples that demonstrate how to use the Microsoft Store submission API in several different programming languages:

Módulo StoreBroker do PowerShellStoreBroker PowerShell module

Como uma alternativa à chamada direta à API de envio da Microsoft Store, nós também fornecemos um módulo do PowerShell de software livre que implementa uma interface de linha de comando sobre API.As an alternative to calling the Microsoft Store submission API directly, we also provide an open-source PowerShell module which implements a command-line interface on top of the API. Esse módulo é chamado StoreBroker.This module is called StoreBroker. Você pode usar esse módulo para gerenciar seu app, versão de pré-lançamento e envios de complemento na linha de comando em vez de chamar diretamente a API de envio da Microsoft Store, ou você pode simplesmente procurar a fonte para ver mais exemplos de como chamar essa API.You can use this module to manage your app, flight, and add-on submissions from the command line instead of calling the Microsoft Store submission API directly, or you can simply browse the source to see more examples for how to call this API. O módulo StoreBroker ativamente é usado dentro da Microsoft como a principal forma de muitos apps de terceiros serem enviados para a Store.The StoreBroker module is actively used within Microsoft as the primary way that many first-party applications are submitted to the Store.

Para obter mais informações, consulte nossa Página do StoreBroker no GitHub.For more information, see our StoreBroker page on GitHub.

Solução de problemasTroubleshooting

ProblemaIssue ResoluçãoResolution
Depois de chamar a API de envio da Microsoft Store do PowerShell, os dados de resposta da API ficarão corrompidos se você convertê-la do formato JSON para um objeto do PowerShell usando o cmdlet ConvertFrom-Json e depois voltar para o formato JSON usando o cmdlet ConvertTo Json.After calling the Microsoft Store submission API from PowerShell, the response data for the API is corrupted if you convert it from JSON format to a PowerShell object using the ConvertFrom-Json cmdlet and then back to JSON format using the ConvertTo-Json cmdlet. Por padrão, o parâmetro -Depth para o cmdlet ConvertTo Json é definido como dois níveis de objetos, que é muito superficial para a maioria dos objetos JSON que são retornados pela API de envio da Microsoft Store.By default, the -Depth parameter for the ConvertTo-Json cmdlet is set to 2 levels of objects, which is too shallow for most of the JSON objects that are returned by the Microsoft Store submission API. Quando você chamar o cmdlet ConvertTo Json, defina o parâmetro -Depth como um número maior, como 20.When you call the ConvertTo-Json cmdlet, set the -Depth parameter to a larger number, such as 20.

Ajuda adicionalAdditional help

Se você tiver dúvidas sobre a API de envio da Microsoft Store ou precisar de ajuda para gerenciar seus envios com essa API, use os seguintes recursos:If you have questions about the Microsoft Store submission API or need assistance managing your submissions with this API, use the following resources:

  • Pergunte em nossos fóruns.Ask your questions on our forums.
  • Visite nossa página de suporte e solicite uma das opções de suporte assistido para o Partner Center.Visit our support page and request one of the assisted support options for Partner Center. Se você for solicitado a escolher um tipo de problema e categoria, escolha Certificação e envio de aplicativo e Enviando um aplicativo, respectivamente.If you are prompted to choose a problem type and category, choose App submission and certification and Submitting an app, respectively.