Saltar para o conteúdo
/
Criar Campanha

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

Criar Campanha

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.

Corpoapplication/jsonobrigatório
campaign_codestringobrigatório

Nome da campanha.

campaign_namesobjectobrigatório

Objeto que contém nomes de campanha traduzidos.

campaign_names.​arstring

Árabe.

campaign_names.​bgstring

Búlgaro.

campaign_names.​cnstring

Chinês (Simplificado).

campaign_names.​csstring

Tcheco.

campaign_names.​destring

Alemão.

campaign_names.​enstring

Inglês.

campaign_names.​esstring

Espanhol.

campaign_names.​frstring

Francês.

campaign_names.​hestring

Hebreu.

campaign_names.​itstring

Italiano.

campaign_names.​jastring

Japonês.

campaign_names.​kostring

Coreano.

campaign_names.​plstring

Polonês.

campaign_names.​ptstring

Português.

campaign_names.​rostring

Romeno.

campaign_names.​rustring

Russo.

campaign_names.​thstring

Tailandês.

campaign_names.​trstring

Turco.

campaign_names.​twstring

Chinês (Tradicional).

campaign_names.​vistring

Vietnamita.

campaign_redeems_count_for_userinteger

Quantidade máxima de resgates de cupons por usuário em uma campanha. Se null for passado, a quantidade de resgates será ilimitada.

expiration_datestring(datetime)

A data de validade da campanha no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

project_idintegerobrigatório

ID de projeto.

redeems_countinteger

Quantidade máxima de resgates de cupons. Se null for passado, a quantidade de resgates será ilimitada.

redeems_count_for_userinteger

Quantidade máxima de resgates de cupons por usuário. Se null for passado, a quantidade de resgates será ilimitada.

subscription_couponobject

Objeto que contém parâmetros de assinatura em uma recompensa.

virtual_currency_amountnumber(float)

Quantia da moeda virtual em uma recompensa.

virtual_itemsobject

Matriz de parâmetros de itens virtuais em uma recompensa.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

Respostas

Criado.

Corpoapplication/json
idinteger
Exemplo: 9134
Resposta
application/json
{
  "id": 9134
}

Adicionar Cupom à Campanha

Pedido

Adicione um código de cupom a uma campanha de cupom.

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.

campaign_idintegerobrigatório

ID de campanha.

Corpoapplication/jsonobrigatório
coupon_codestringobrigatório

Código de cupom.

Exemplo: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Respostas

Nenhum conteúdo.

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.

Subscription management

Operações