Saltar para o conteúdo
/
Promoção de cupom de atua...

LiveOps API (2.0.0)

Visão geral

  • Versão: 2.0.0
  • Servidores: https://store.xsolla.com/api
  • Contate-nos por e-mail
  • URL de contato: https://xsolla.com/
  • Versão TLS necessária: 1.2

LiveOps é um kit de ferramentas para gerar engajamento contínuo com os jogadores através de promoções e ofertas personalizadas.

Use a API para gerenciar os seguintes recursos:

  • Promoções — crie e gerencie cupons, códigos promocionais, descontos e campanhas bônus.
  • Personalização — especifique as condições para exibir o catálogo de itens e aplicar as promoções somente para certos usuários autorizados.
  • Limites de promoção — defina um limite sobre quantas vezes uma promoção pode ser usada por um usuário e configure as redefinições programadas para esses limites.
  • Cadeias de recompensas e pontos de valor — configure a progressão de recompensas vinculada ao acúmulo de pontos de valor.
  • Cadeias diárias — configure recompensas diárias recorrentes para motivar acessos regulares.
  • Cadeias de ofertas — construa ofertas de compra sequenciais com precificações por etapa e opções de recompensas gratuitas.
  • Venda cruzada — um método de venda na qual o usuário recebe a oferta de comprar um item com valor adicional.

Chamadas API

A API se divide nos seguintes grupos:

  • Admin — chamadas para criar, atualizar, ativar e excluir campanhas e configurações de cadeias. Autenticada via autenticação de acesso básica com seu comerciante ou as credenciais do projeto.
  • Client — chamadas para recuperar as promoções disponíveis, obter cadeias ativas, resgatar códigos e resgatar recompensas em nome de usuários finais autenticados. Autenticado via JWT de usuário.
Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/

Comum

Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Ganhe promoção de cupomServer-sideAdmin

Pedido

Obtém uma promoção de cupom 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://store.xsolla.com/api/v3/project/44056/admin/coupon/coupon_44056_1

Respostas

O cupom 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)
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
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"}
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_coupon_total_limit_state)

Limites para cada código de cupom exclusivo.

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

Promoção de cupom de atualizaçãoServer-sideAdmin

Pedido

Atualiza uma promoção de cupom.

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)
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
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://store.xsolla.com/api/v3/project/44056/admin/coupon/coupon_44056_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 1,
        "sku": "com.xsolla.elven_sword_2"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "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 cupom foi atualizado com sucesso.

Resposta
Sem conteúdo

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

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

Gestão

Operações

Admin

Operações

Cliente

Operações

Cliente de clãs

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações