Saltar para o conteúdo
/
Obter o saldo de pontos d...

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

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

Obtenha as cadeias de recompensa do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Obtém as cadeias de recompensa do usuário atual.

Atenção

Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Segurança
XsollaLoginUserJWT
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
Consulta
limitinteger>= 1

Limite da quantidade de elementos na página.

Exemplo: limit=50
offsetinteger>= 0

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

Exemplo: offset=0
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

A cadeia de recompensas do usuário foi recuperada com sucesso.

Corpoapplication/json
has_moreboolean

Usado como um indicador de que há mais páginas.

Exemplo: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

Número total de cadeias de recompensa no sistema.

Exemplo: 10
Resposta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … }
  ],
  "total_items_count": 1
}

Obter o saldo de pontos de valor do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Obtém o saldo de pontos de valor do usuário atual.

Segurança
XsollaLoginUserJWT
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
reward_chain_idintegerobrigatório

ID da cadeia de recompensas.

Exemplo: 101
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

O saldo de pontos de valor do usuário foi recuperado com sucesso.

Corpoapplication/json
amountinteger

Quantidade de pontos de valor.

descriptionstring or null(value-point-description)

Descrição do ponto de valor.

image_urlstring(Common_admin-image_url)

URL da imagem.

Exemplo: "https://image.example.com"
is_clanboolean(is_clan)

Se o ponto de valor é usado em cadeias de recompensa de clã ou não.

Exemplo: true
long_descriptionstring or null(value-point-long-description)

Descrição longa do ponto de valor.

namestring(value-point-name)

Nome do ponto de valor.

skustring(value-point-sku)

ID de ponto de valor exclusivo.

Resposta
application/json
{
  "amount": 80,
  "description": "Value points for clan reward system.",
  "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
  "is_clan": true,
  "long_description": "Value points given to clans to get new rewards in a reward chain.",
  "name": "Clan Reward VP 1",
  "sku": "com.xsolla.clan_value_point_1"
}

Resgatar recompensa por etapaClient-side

Pedido

Ponto de extremidade do cliente. Reivindica a recompensa de passo do usuário atual de uma cadeia de recompensas.

Segurança
XsollaLoginUserJWT
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
reward_chain_idintegerobrigatório

ID da cadeia de recompensas.

Exemplo: 101
step_idintegerobrigatório

ID de etapa de cadeia de recompensa.

Exemplo: 120
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Reivindicou com sucesso a recompensa de passo do usuário atual de uma cadeia de recompensas.

Resposta
Sem conteúdo

Cliente de clãs

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações