Criar um complemento

  • Artigo

Use esse método na API de envio da Microsoft Store para criar um complemento (também conhecido como produto no aplicativo ou IAP) para um aplicativo registrado em sua conta do Partner Center.

Observação

Este método cria um complemento sem nenhum envio. Para criar um envio para um complemento, veja os métodos em Gerenciar envios de complemento.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.

Solicitação

Esse método tem a seguinte sintaxe. Veja as seções a seguir para obter exemplos de uso e descrições do corpo da solicitação e do cabeçalho.

Método URI da solicitação
POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso Azure AD notoken> de portador< do formulário.

Corpo da solicitação

O corpo da solicitação tem os parâmetros a seguir.

Parâmetro Type Descrição Obrigatório
applicationIds array Uma matriz que contém a ID da Loja do aplicativo ao qual esse complemento está associado. Essa matriz é compatível com apenas um item. Sim
productId string A ID do produto do complemento. Este é um identificador que pode ser usado no código para fazer referência ao complemento. Para obter mais informações, consulte Definir seu tipo de produto e a ID do produto. Sim
productType string O tipo de produto do complemento. Há suporte para os seguintes valores: Durável e Consumíveis. Sim

Exemplo de solicitação

O exemplo a seguir demonstra como criar um novo complemento consumível para um aplicativo.

POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Content-Type: application/json
{
    "applicationIds": [  "9NBLGGH4R315"  ],
    "productId": "my-new-add-on",
    "productType": "Consumable",
}

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método. Para obter mais detalhes sobre os valores no corpo da resposta, veja recurso do complemento.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "my-new-add-on",
  "productType": "Consumable",
}

Códigos do Erro

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Descrição
400 A solicitação é inválida.
409 O complemento não pôde ser criado devido ao seu estado atual ou o complemento usa um recurso do Partner Center que atualmente não tem suporte da API de envio da Microsoft Store.