Partilhar via

Criar e gerenciar envios

Use a API de submissão da Microsoft Store para consultar e criar submissões programaticamente para aplicações, suplementos e voos de pacotes para a sua conta ou para a conta do Partner Center da sua organização. Essa API é útil se sua conta gerencia muitos aplicativos ou complementos e você deseja automatizar e otimizar o processo de envio desses ativos. Essa API usa o Azure Ative Directory (Azure AD) para autenticar as chamadas do seu aplicativo ou serviço.

As etapas a seguir descrevem o processo de ponta a ponta do uso da API de envio da Microsoft Store:

  1. Certifique-se de que preencheu todos os pré-requisitos.
  2. Antes de chamar um método na API de envio da Microsoft Store, deve obter o token de acesso do Azure AD. Depois de obter um token, você tem 60 minutos para usá-lo em chamadas para a API de envio da Microsoft Store antes que o token expire. Depois que o token expirar, você poderá gerar um novo token.
  3. Chame a API de envio da Microsoft Store.

Importante

Se você usar essa API para criar um envio para um aplicativo, voo de pacote ou complemento, certifique-se de fazer mais alterações no envio somente usando a API, em vez de no Partner Center. Se você usar o Partner Center para alterar um envio criado originalmente usando a API, não poderá mais alterar ou confirmar esse envio usando a API. Em alguns casos, o envio pode ser deixado em um estado de erro onde não pode prosseguir no processo de envio. Se isso ocorrer, você deve excluir o envio e criar um novo envio.

Importante

Não é possível usar essa API para publicar envios para compras em volume por meio da Microsoft Store para Empresas e da Microsoft Store para Educação ou para publicar envios para aplicativos LOB diretamente para empresas. Para ambos os cenários, você deve usar publicar o envio no Partner Center.

Observação

Essa API não pode ser usada com aplicativos ou complementos que usam atualizações obrigatórias de aplicativos e complementos consumíveis gerenciados pela Loja. Se você usar a API de envio da Microsoft Store com um aplicativo ou complemento que use um desses recursos, a API retornará um código de erro 409. Nesse caso, você deve usar o Partner Center para gerenciar os envios para o aplicativo ou complemento.

Observação

Não é possível usar essa API com aplicativos ou complementos que estão na Versão de Preços 2. Um produto está na Versão de Preço 2 se houver um botão Revisar preço por mercado na seção Preço da página Preço e disponibilidade . Se utilizares a API de envio da Microsoft Store com uma aplicação ou complemento que esteja na Versão de Preços 2, a API retornará um nível desconhecido para a parte de preços. Você pode continuar usando essa API para atualizar módulos diferentes de Preço e disponibilidade.

Etapa 1: concluir os pré-requisitos para usar a API de envio da Microsoft Store

Antes de começar a escrever código para chamar a API de envio da Microsoft Store, certifique-se de ter concluído os seguintes pré-requisitos.

  • Você (ou sua organização) deve ter um diretório do Azure AD e deve ter permissão de administrador global para o diretório. Se você já usa o Microsoft 365 ou outros serviços corporativos da Microsoft, já tem o diretório do Azure AD. Caso contrário, você pode criar um novo Azure AD no Partner Center sem custo adicional.

  • Você deve associar uma aplicação do Azure AD à sua conta do Partner Center e obter o seu ID do inquilino, ID do cliente e chave. Você precisa desses valores para obter um token de acesso do Azure AD, que será usado em chamadas para a API de envio da Microsoft Store.

  • Prepare seu aplicativo para uso com a API de envio da Microsoft Store:

    • Se a sua aplicação ainda não existir no Partner Center, deve criar a sua aplicação reservando o seu nome no Partner Center. Não é possível usar a API de envio da Microsoft Store para criar um aplicativo no Partner Center; você deve trabalhar no Partner Center para criá-lo e, depois disso, você pode usar a API para acessar o aplicativo e criar envios programaticamente para ele. No entanto, pode usar a API para criar programaticamente complementos e pacotes de voos antes de os submeter.

    • Antes de criar uma submissão para uma determinada aplicação usando esta API, deve primeiro criar uma submissão para a aplicação no Partner Center, incluindo responder ao questionário de classificações etárias . Depois de fazer isso, você será capaz de criar programaticamente novos envios para este aplicativo usando a API. Não é necessário criar uma submissão de complemento ou uma submissão de voo de pacote antes de usar a API para esses tipos de submissões.

    • Se estiver a criar ou atualizar uma submissão de aplicação e precisar incluir um pacote de aplicação, prepare o pacote de aplicação.

    • Se estiver a criar ou atualizar uma submissão de aplicação e precisar incluir capturas de ecrã ou imagens para a listagem da Loja, prepare as capturas de ecrã e as imagens da aplicação.

    • Se estiver a criar ou a atualizar uma submissão de suplemento e precisar incluir um ícone, prepare o ícone.

Como associar um aplicativo do Azure AD à sua conta do Partner Center

Antes de poder usar a API de envio da 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. O aplicativo do Azure AD representa o aplicativo ou serviço do qual você deseja chamar a API de envio da Microsoft Store. Você precisa da ID do locatário, da ID do cliente e da chave para obter um token de acesso do Azure AD que você passa para a API.

Observação

Você só precisa executar essa tarefa uma vez. Depois de ter a ID do locatário, a ID do cliente e a chave, você poderá reutilizá-los sempre que precisar criar um novo token de acesso do Azure AD.

  1. No Partner Center, associe a conta do Partner Center da sua organização ao diretório do Azure AD da sua organização.

  2. Em seguida, na página de Utilizadores na secção de Configurações da Conta do Partner Center, adicione a aplicação do Azure AD que representa a aplicação ou serviço que usará para aceder a submissões para a sua conta do Partner Center. Certifique-se de atribuir a função Manager a este aplicativo. Se o aplicativo ainda não existir no diretório do Azure AD, você poderá criar um novo aplicativo do Azure AD no Partner Center.

  3. Retorne à página Usuários , clique no nome do seu aplicativo do Azure AD para ir para as configurações do aplicativo e copie os valores de ID do Locatário e ID do Cliente .

  4. Clique em Adicionar nova chave. No ecrã seguinte, anote o valor da chave . Você não poderá acessar essas informações novamente depois de sair desta página. Para obter mais informações, consulte Gerenciar chaves para um aplicativo do Azure AD.

Etapa 2: Obter um token de acesso do Azure AD

Antes de chamar qualquer um dos métodos na API de submissão da Microsoft Store, deve primeiro obter um token de acesso do Azure AD que deve ser passado para o cabeçalho de Autorização de cada método na API. Depois de obter um token de acesso, você tem 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá atualizá-lo para continuar a usá-lo em outras chamadas para a API.

Para obter o token de acesso, siga as instruções em Service to Service Calls Using Client Credentials para enviar um HTTP POST para o endpoint https://login.microsoftonline.com/<tenant_id>/oauth2/token. Aqui está um pedido de amostra.

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 tenant_id no URI POST e os parâmetros client_id e client_secret , 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. Para o parâmetro de recurso , deve especificar https://manage.devcenter.microsoft.com.

Depois que seu token de acesso expirar, você poderá buscar um novo fazendo a mesma chamada HTTP novamente.

Para obter exemplos que demonstram como obter um token de acesso usando código C#, Java ou Python, consulte os exemplos de código da API de envio da Microsoft Store.

Etapa 3: Usar a API de envio da Microsoft Store

Depois de ter um token de acesso do Azure AD, você pode chamar métodos na API de envio da Microsoft Store. A API inclui muitos métodos que são agrupados em cenários para aplicativos, complementos e voos de pacote. Para criar ou atualizar envios, normalmente você chama vários métodos na API de envio da Microsoft Store em uma ordem específica. Para obter informações sobre cada cenário e a sintaxe de cada método, consulte os artigos na tabela a seguir.

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.

Cenário Descrição
Aplicações Recupere dados de todos os aplicativos registrados na sua conta do Partner Center e crie envios para aplicativos. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:
Suplementos Obtenha, crie ou exclua complementos para as suas aplicações e, em seguida, obtenha, crie ou exclua submissões para os complementos. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:
Voos organizados Obtenha, crie ou elimine voos de pacote para os teus aplicativos e, em seguida, obtenha, crie ou elimine submissões para os voos de pacote. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:

Exemplos de código

Os artigos a seguir fornecem exemplos de código detalhados que demonstram como usar a API de envio da Microsoft Store em várias linguagens de programação diferentes:

Módulo StoreBroker PowerShell

Como alternativa para chamar a API de envio da Microsoft Store diretamente, também fornecemos um módulo PowerShell de código aberto que implementa uma interface de linha de comando sobre a API. Este módulo é chamado StoreBroker. Você pode usar este módulo para gerenciar seus envios de aplicativos, voos e complementos a partir da linha de comando, em vez de chamar a API de envio da Microsoft Store diretamente, ou pode simplesmente navegar na fonte para ver mais exemplos de como chamar essa API. O módulo StoreBroker é usado ativamente dentro da Microsoft como a principal maneira pela qual muitos aplicativos primários são enviados para a Loja.

Para obter mais informações, consulte nossa página StoreBroker no GitHub.

Solução de problemas

Questão Resolução
Depois de chamar a API de envio da Microsoft Store do PowerShell, os dados de resposta da API serão corrompidos se você convertê-la do formato JSON em um objeto do PowerShell usando o cmdlet ConvertFrom-Json e, em seguida, de volta para o formato JSON usando o cmdlet ConvertTo-Json . Por padrão, o parâmetro -Depth para o cmdlet ConvertTo-Json é definido como 2 níveis de objetos, o que é muito superficial para a maioria dos objetos JSON retornados pela API de envio da Microsoft Store. Ao chamar o cmdlet ConvertTo-Json , defina o parâmetro -Depth para um número maior, como 20.

Ajuda adicional

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:

  • Coloque as suas questões nos nossos fóruns.
  • Visite nossa página de suporte e solicite uma das opções de suporte assistido para o Partner Center. Se lhe for solicitado escolher um tipo e uma categoria de problema, selecione Submissão e certificação de aplicações e Submissão de uma aplicação, respectivamente.
  • Last updated on