Saltar para o conteúdo

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
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/
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
Operações
Operações
Operações
Operações
Operações
Operações

Obtém a recompensa diária do usuário atual por seu IDClient-side

Pedido

Ponto de extremidade do cliente. Obtém a recompensa diária do usuário atual por seu ID.

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
daily_chain_idintegerobrigatório

ID de recompensa diária.

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

Respostas

As recompensa diária do usuário foi recuperada com sucesso.

Corpoapplication/json
date_startstring(date-time)(calendar_hard_date_start)

Data em que sua cadeia de recompensas diárias começa.

Exemplo: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Se a recompensa diária é recorrente. Se true, a recompensa diária será redefinida automaticamente após a data de término. O próximo cronograma start_date e end_date são baseados na quantidade de etapas de recompensas diárias e no tempo inicial definido em start_date.

Padrão false
Exemplo: true
typestring

Tipo de recompensa diária que determina quando os usuários podem resgatar recompensas.

Enum ValorDescrição
calendar_hard

Desbloqueia a recompensa da próxima etapa a cada 24 horas. Quaisquer recompensas de etapas não resgatadas são perdidas permanentemente quando a recompensa da próxima etapa ficar disponível.

rolling_skippable

Desbloqueia a recompensa da próxima etapa a cada 24 horas com base em date_start. A progressão é sequencial: uma nova recompensa não será desbloqueada até que a anterior seja resgatada. Se um usuário pular um ou mais dias, ele continuará de onde parou; Os dias perdidos não concedem múltiplas recompensas.

rolling_unskippable

Desbloqueia a recompensa da próxima etapa a cada 24 horas com base em date_start. A progressão é sequencial: uma nova recompensa não será desbloqueada até que a anterior seja resgatada. No entanto, se um usuário pular um dia, seu progresso é redefinido e ele deverá começar novamente a partir da primeira etapa.

Discriminador
date_endstring or null(date-time)(daily_chain_date_end)

Data em que sua recompensa diária termina. Pode ser null. Definir como tipo calendar_hard definirá automaticamente essa data com base no número de etapas adicionadas, então você pode deixá-la como null.

Exemplo: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Descrição da recompensa diária.

Exemplo: "Major weekly quest"
idinteger

ID de recompensa diária.

Exemplo: 9
namestring

Nome da recompensa diária.

Exemplo: "Weekly quest"
orderinteger(order)

Define a ordem do arranjo.

Exemplo: 1
stepsArray of objects(client-daily-chain-step-model)
Resposta
application/json
{ "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": "Active daily reward description", "id": 101, "name": "Active daily reward", "order": 1, "steps": [ {}, {}, {}, {} ], "type": "calendar_hard" }

Resgatar etapa da recompensa diáriaClient-side

Pedido

Ponto de extremidade do cliente. Resgata a recompensa de etapa do usuário atual a partir de uma recompensa diária. Todas as etapas só podem ser resgatadas em ordem sequencial. A recompensa de uma etapa perdida não pode ser obtida com moedas virtuais ou reais, nem assistindo a um anúncio.

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
daily_chain_idintegerobrigatório

ID de recompensa diária.

Exemplo: 101
step_numberintegerobrigatório

Número da etapa de recompensa diária.

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

Respostas

Resgatou a recompensa de etapa do usuário atual por uma etapa de recompensa diária com sucesso.

Resposta
Sem conteúdo
Operações
Operações
Operações
Operações