Saltar para o conteúdo
/
Obet Cupom

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

Cupons

Operações

Anexar Campanha à Promoção

Pedido

Anexe uma campanha de cupom a uma promoção específica.

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
campaignsArray of integersobrigatório

Matriz de IDs de campanhas.

Exemplo: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Respostas

Nenhum conteúdo.

Obet Cupom

Pedido

Obter dados do cupom com o código dele.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

codestringobrigatório

Código de cupom.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Respostas

OK.

Corpoapplication/json
keystring

Chave do atributo do usuário.

list_of_valuesArray of objects

Matriz de valores possíveis para um tipo enumerado.

nameobject

Nomes de atributos traduzidos.

skip_condition_on_nonexistent_keyboolean

Se a condição deve ser ignorada caso não haja chave.

typestring

Tipo de chave.

Enum"int""string""enum""date"
visibleboolean
Resposta
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Resgatar Cupom

Pedido

Resgate um cupom com o código dele.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

codestringobrigatório

Código de cupom.

Corpoapplication/jsonobrigatório
user_idstringobrigatório

ID de usuário.

Exemplo: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

Respostas

OK.

Corpoapplication/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
Resposta
application/json
{
  "campaign_code": "new_campaign",
  "coupon_code": "ddgf5bn4",
  "coupon_id": 89613996,
  "expiration_date": "2019-12-31T00:00:00+00:00",
  "is_active": true,
  "project_id": 12345,
  "redeems_count_for_user": 10,
  "redeems_count_remain": 20,
  "subscription_coupon": null,
  "virtual_currency_amount": 200,
  "virtual_items": []
}

Subscription management

Operações