Criar e gerenciar envios
Use a API de envio da Microsoft Store para consultar e criar programaticamente envios para aplicativos, complementos e pacotes de pré-lançamento para sua conta do Partner Center ou 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 Active Directory (Azure AD) para autenticar as chamadas do aplicativo ou serviço.
As etapas a seguir descrevem o processo de uso ponta a ponta da API de envio da Microsoft Store:
- Certifique-se de ter concluído todos os pré-requisitos.
- Antes de chamar um método na API de envio da Microsoft Store, obtenha um 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 ele expire. Depois que o token expirar, será possível gerar um novo.
- Chame a API de envio da Microsoft Store.
Importante
Se você usar essa API para criar um envio para um aplicativo, pacote de pré-lançamento 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ê deverá excluir o envio e criar um novo envio.
Importante
Você não pode usar essa API para publicar envios para compras por volume por meio da Microsoft Store para Empresas e da Microsoft Store para Educação ou para publicar envios de 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 usa um desses recursos, a API retornará um código de erro 409. Nesse caso, você deve usar o Partner Center para gerenciar os envios do aplicativo ou complemento.
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, verifique se você concluiu os pré-requisitos a seguir.
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. Se já usa o Microsoft 365 ou outros serviços empresariais da Microsoft, você já tem o diretório do Azure AD. Caso contrário, crie um Azure AD na Central de Parceiros sem custo adicional.
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. 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.
Prepare seu aplicativo para uso com a API de envio da Microsoft Store:
Se seu aplicativo ainda não existir na Central de Parceiros, você deverá criá-lo reservando seu nome na Central de Parceiros. Não é possível usar a API de envio da Microsoft Store para criar um aplicativo na Central de Parceiros; você deve trabalhar na Central de Parceiros para criá-lo e, depois disso, pode usar a API para acessar o aplicativo e criar envios programaticamente para ele. No entanto, você pode usar a API para criar programaticamente complementos e pacotes de pré-lançamento antes de criar envios para eles.
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. Depois de fazer isso, você poderá criar programaticamente envios para esse aplicativo usando a API. Você não precisa criar um envio de complemento ou envio de pacote de pré-lançamento antes de usar a API para esses tipos de envios.
Se você estiver criando ou atualizando um envio de aplicativo e precisar incluir um pacote de aplicativos, prepare o pacote do aplicativo.
Se você estiver criando ou atualizando um envio de aplicativo e precisar incluir capturas de tela ou imagens para a listagem da Store, prepare as capturas de tela e imagens do aplicativo.
Se você estiver criando ou atualizando um envio de complemento e precisar incluir um ícone, prepare o ícone.
Como associar um aplicativo do Azure AD à sua conta da Central de Parceiros
Antes de usar a API de envio da Microsoft Store, você deve associar um aplicativo 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 é passado para a API.
Observação
É necessário executar essa tarefa apenas uma vez. 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.
Na Central de Parceiros, associe a conta da Central de Parceiros da sua organização ao diretório do Azure AD da sua organização.
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. Lembre-se de atribuir esse aplicativo à função de Gerenciador. Se o aplicativo ainda não existir no diretório do Azure AD, crie um novo aplicativo do Azure AD na Central de Parceiros.
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.
Clique em Adicionar nova chave. Na tela a seguir, copie o valor da Chave. Você não poderá acessar essas informações novamente depois de sair da página. Para saber mais, veja Gerenciar chaves de 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 envio da Microsoft Store, você deve primeiro obter um token de acesso do Azure AD que você passa para o cabeçalho de autorização de cada método na API. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois de expirar, é possível renovar o token para que você possa continuar a usá-lo em chamadas futuras para a API.
Para obter o token de acesso, siga as instruções em Chamadas de Serviço para Serviço Usando Credenciais do Cliente para enviar um HTTP POST para o ponto de extremidade https://login.microsoftonline.com/<tenant_id>/oauth2/token. Confira a seguir um exemplo de solicitação.
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 POST URI e nos parâmetros client_id e client_secret, especifique a ID do locatário, a ID do cliente e a chave para o aplicativo recuperado do Partner Center na seção anterior. Para o parâmetro resource, especifique https://manage.devcenter.microsoft.com.
Depois que o 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: Uso da 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 agrupados em cenários para aplicativos, complementos e pacotes de pré-lançamento. Para criar ou atualizar envios, você normalmente 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, confira 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 |
|---|---|
| Aplicativos | Recupere dados de todos os aplicativos registrados em sua conta do Partner Center e crie envios para aplicativos. Para obter mais informações sobre esses métodos, consulte os seguintes artigos: |
| Complementos | Obtenha, crie ou exclua complementos para seus aplicativos e, em seguida, obtenha, crie ou exclua envios para os complementos. Para obter mais informações sobre esses métodos, consulte os seguintes artigos: |
| Pacotes de pré-lançamento | Obtenha, crie ou exclua pacotes de pré-lançamento para seus aplicativos e, em seguida, obtenha, crie ou exclua envios para os pacotes de pré-lançamento. 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:
- Exemplo de C#: envios para aplicativos, complementos e versões de pré-lançamento
- Exemplo de C#: envio de aplicativo com opções de jogo e trailers
- Amostra de Java: envios para aplicativos, complementos e versões de pré-lançamento
- Exemplo de Java: envio de aplicativo com opções de jogo e trailers
- Exemplo de Python: envios para aplicativos, complementos e versões de pré-lançamento
- Exemplo de Python: envio de aplicativo com opções de jogo e trailers
Módulo PowerShell StoreBroker
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 aplicativo, voo e complemento a partir da linha de comando em vez de chamar a API de envio da Microsoft Store diretamente, ou simplesmente navegar na origem para ver mais exemplos de como chamar essa API. O módulo StoreBroker é usado ativamente na 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
| Problema | 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 como um número maior, como 20. |
Ajuda adicional
Se você tiver dúvidas sobre a API de envio da Microsoft Store ou precisar de assistência para gerenciar seus envios com essa API, use os seguintes recursos:
- Faça perguntas em nossos fóruns.
- Visite nossa página de suporte e solicite uma das opções de suporte assistido para a Central de Parceiros. Se você for solicitado a escolher um tipo e uma categoria de problema, escolha Envio e certificação de aplicativo e Enviando um aplicativo, respectivamente.