Compartilhar via


Criar um complemento

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

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

Pré-requisitos

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

  • Se você ainda 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 esse 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.

Solicitar

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

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Corpo da solicitação

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

Parâmetro Tipo Descrição Obrigatório
IDs de aplicativos matriz Uma matriz que contém a ID da Loja do aplicativo ao qual esse complemento está associado. Há suporte para apenas um item nessa matriz. Sim
productId string A ID do produto do complemento. Esse é um identificador que pode ser usado no código para se referir ao complemento. Para obter mais informações, consulte Definir o tipo de produto e a ID do produto. Sim
productType string O tipo de produto do complemento. Os seguintes valores são suportados: Durável e Consumível. 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, consulte recurso complementar.

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

Códigos do Erro

Se a solicitação não puder ser concluída com êxito, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Description
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.