Saltar para o conteúdo

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps API fornece endpoints para aumentar o engajamento dos jogadores.

Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/
https://store.xsolla.com/api/
Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

Obter promoção de código promocionalServer-sideAdmin

Pedido

Obtém uma promoção de código promocional especificada.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
external_idintegerobrigatório

ID externo de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: coupon_44056_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/44056/admin/promocode/coupon_44056_1

Respostas

O código promocional foi recebido com sucesso.

Corpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

Condições para validação de atributos do usuário. Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.

bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null
Exemplo: {"discount":{"percent":"10.99"}}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Lista de itens que são descontados por um código promocional.

excluded_promotionsArray of integers(excluded_promotions)

Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]

Exemplo: [12,789]
external_idstring(Promotions_coupon-external_id)

ID de promoção exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

Padrão "coupon_external_id"
Exemplo: "coupon_external_id"
is_enabledboolean(Promotions_coupon-is_enabled)
Padrão true
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Conjunto de objetos com condições que definem a faixa de preço para aplicar a promoção a determinados itens no carrinho.
O preço de cada item no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados somente aos itens no carrinho cujo preço atende à condição.
Se você passar esta matriz, defina o valor da matriz discounted_items como null.

nameobject(Promotions_coupon_name)

Nome da promoção. Deve conter pares chave/valor onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.

Padrão {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
price_conditionsArray of objects or null(price_conditions_promocode)

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção ao carrinho inteiro.
O preço total de todos os itens no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados a todos os itens no carrinho se o preço do carrinho atender à condição especificada.
Se você passar esta matriz, defina o valor da matriz discounted_items como null.

promotion_periodsArray of objects(promotion_periods)

Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Número de resgates por código.

Padrão 10
Exemplo: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limita o número total de cupons.

Padrão 10
Exemplo: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limita o número total de cupons resgatados por um único usuário.

Padrão 10
Exemplo: 10
total_limit_stateobject or null(Promotions_promocode_total_limit_state)

Limites para cada código promocional exclusivo.

Resposta
application/json
{ "bonus": [ {} ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ {}, {} ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }

Atualizar promoção de código promocionalServer-sideAdmin

Pedido

Atualiza uma promoção de código promocional.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
external_idintegerobrigatório

ID externo de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: coupon_44056_1
Corpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Condições para validação de atributos do usuário. Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.

bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null
Exemplo: {"percent":"10.10"}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Lista de itens que são descontados por um código promocional.

excluded_promotionsArray of integers(excluded_promotions)

Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]

Exemplo: [12,789]
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Conjunto de objetos com condições que definem a faixa de preço para aplicar a promoção a determinados itens no carrinho.
O preço de cada item no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados somente aos itens no carrinho cujo preço atende à condição.
Se você passar esta matriz, defina o valor da matriz discounted_items como null.

nameobject(Promotions_coupon_name)obrigatório

Nome da promoção. Deve conter pares chave/valor onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.

Padrão {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringpropriedade adicional
price_conditionsArray of objects or null(price_conditions_promocode)

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção ao carrinho inteiro.
O preço total de todos os itens no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados a todos os itens no carrinho se o preço do carrinho atender à condição especificada.
Se você passar esta matriz, defina o valor da matriz discounted_items como null.

promotion_periodsArray of objects(promotion_periods)

Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Número de resgates por código.

Padrão 10
Exemplo: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limita o número total de cupons.

Padrão 10
Exemplo: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limita o número total de cupons resgatados por um único usuário.

Padrão 10
Exemplo: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/44056/admin/promocode/coupon_44056_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "discount": {
      "percent": "10.10"
    },
    "name": {
      "de-DE": "Neujahrsrabatt",
      "en-US": "New Year Discount"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respostas

O código promocional foi atualizado com sucesso.

Resposta
Sem conteúdo

Ofertas de catálogo exclusivas

Essa API permite que você gerencie ofertas de catálogo exclusivas.

Operações

Descontos

Esta API permite-lhe gerir promoções de desconto.

Operações

Bônus

Esta API permite gerenciar promoções de bônus.

Operações

Catálogo personalizado

Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.

Para promoções personalizadas, consulte a seção Promotions.

Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.

Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações