Saltar para o conteúdo
/
Revisar Promoção

Subscriptions API (2.0)

Visão geral

  • Versão: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Essa referência API descreve os pontos de extremidade na gerência de assinaturas, cupons e promoções. Para obter mais informações sobre as Assinaturas, veja o guia do produto e o glossário.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/

Token

Operações

Planos

Operações

Produtos

Operações

Subscription management

Operações

Pagamentos

Operações

Promoções

Operações

Definir Períodos de Validade

Pedido

Define intervalos de data/hora quando uma promoção é válida. Se a promoção for somente leitura (read_only = true), você não poderá editar períodos existentes, mas poderá adicionar novos.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

promotion_idintegerobrigatório

ID de promoção.

Corpoapplication/jsonobrigatório
periodsArray of objects

Intervalos de tempo/data.

periods[].​fromstring(datetime)

Início do período.

periods[].​offsetstring

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

periods[].​tostring(datetime)

Fim do período.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Respostas

Nenhum conteúdo.

Revisar Promoção

Pedido

Você precisa revisar uma promoção antes de ativá-la. Este método retorna a lista de erros, se houver.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

promotion_idintegerobrigatório

ID de promoção.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/review'

Respostas

OK.

Corpoapplication/jsonArray [
componentstring
messagestring
]
Resposta
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Obter Recompensas

Pedido

Obtém a lista de recompensas associadas a uma promoção.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

promotion_idintegerobrigatório

ID de promoção.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards'

Respostas

OK.

Corpoapplication/json
idinteger
itemobject

Defina a recompensa para itens virtuais específicos.

item.​bonusArray of objects

Itens virtuais extras concedidos como bônus.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

Nome do plano no idioma padrão (en), replica o valor name.en.

item.​bonus[].​quantityinteger

Quantidade de itens virtuais entregues como um bônus.

item.​bonus[].​skustring

SKU do item.

item.​discountArray of objects

Descontos por itens virtuais específicos.

item.​discount[].​discount_percentnumber(float)

Percentual de desconto.

item.​discount[].​localized_namestring

Nome do plano no idioma padrão (en), replica o valor name.en.

item.​discount[].​max_amountnumber(integer)

Quantidade máxima de itens aos quais pode-se aplicar uma promoção.

item.​discount[].​skustring

SKU do item.

packageobject

Defina a recompensa para um pacote de moedas virtuais.

package.​bonus_amountnumber(float)

Recompensa como quantia absoluta da moeda virtual.

package.​bonus_percentnumber(float)

Recompensa como percentual da quantia do pacote.

purchaseobject

Defina a recompensa para a compra toda.

purchase.​discount_percentnumber(float)

Percentual de desconto.

subscriptionobject

Define a recompensa de uma assinatura.

subscription.​trial_daysinteger

O período de teste em dias.

Resposta
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Cupons

Operações

Subscription management

Operações