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.
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.
Pedido
Atualiza todos os limites em todas as promoções para o usuário especificado para que ele possa usar essas promoções novamente.
A API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:
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}/admin/user/limit/promotion/all
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/all
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/all \
-H 'Content-Type: application/json' \
-d '{
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'Pedido
Diminui o número restante de vezes que o usuário especificado pode usar uma promoção dentro do limite aplicado.
A API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
-H 'Content-Type: application/json' \
-d '{
"available": 1,
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'{ "per_user": { "available": 9, "total": 10 } }
Pedido
Obtém o número restante de vezes que o usuário especificado pode usar a promoção dentro do limite aplicado.
A API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:
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}/admin/user/limit/promotion/id/{promotion_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'{ "per_user": { "available": 9, "total": 10 } }