- Obter toda a lista de promoções
LiveOps API (2.0.0)
- 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.
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.
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
- https://store.xsolla.com/api/v2/project/{project_id}/promotion/code/{code}/verify
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/{project_id}/promotion/code/{code}/verify
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://store.xsolla.com/api/v2/project/44056/promotion/code/WINTER2021/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "code": "WINTER2023", "rewards": { "bonus": [ … ], "is_selectable": true }, "type": "coupon" }
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/promotion
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v3/project/44056/admin/promotion?limit=50&offset=0&enabled=0'{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/redeemable/code/WINTER2021A promoção foi recebida com sucesso.
Lista de itens que são descontados por um código promocional. Apenas para códigos promocionais.
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.
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.
Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.
Número de resgates por código.
Limita o número total de cupons.
Limita o número total de cupons resgatados por um único usuário.
{ "bonus": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }
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.