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

Obter os 10 maiores contribuintes da cadeia de recompensas no clãClient-side

Pedido

Recupera a lista dos 10 maiores contribuidores para a cadeia de recompensas específica no clã do usuário atual. Se um usuário não pertence a um clã, a chamada retornará uma matriz vazia.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID 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/clan/contributors/101/top \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

A lista dos 10 principais contribuintes para a cadeia de recompensas do clã.

Corpoapplication/jsonArray [
contributed_amountinteger

A quantidade de pontos de valor contribuídos pelo usuário.

Exemplo: 100
namestring

ID de usuário. Este é o ID enviado à Xsolla durante a autorização e vincula o usuário ao seu projeto Xsolla Login.

Exemplo: "Rocket"
]
Resposta
application/json
[ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ]

Atualizar o clã do usuário atualClient-side

Pedido

Atualiza o clã de um usuário atual por meio de atributos de usuário. Resgata todas as recompensas de cadeias de recompensas que não foram resgatadas de um clã anterior e as retorna na resposta. Se o usuário estava em um clã e agora não está mais, sua inclusão no clã será revogada. Se o usuário mudou de clã, o clã será alterado.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto.

Padrão 44056
curl -i -X PUT \
  'https://store.xsolla.com/api/v2/project/{project_id}/user/clan/update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

O clã do usuário foi atualizado com sucesso.

Corpoapplication/json
rewardArray of objects
Resposta
application/json
{ "reward": [ {}, {} ] }
Operações
Operações
Operações
Operações
Operações
Operações