Quantidade do item.
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.
Transferir a descrição da OpenAPI
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/promotion/bonus
- 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/bonus?limit=50&offset=0'Resposta
application/json
{ "active_promotions_count": 2, "inactive_promotions_count": 0, "promotions": [ { … }, { … } ], "total_promotions_count": 2 }
Caminho
Corpoapplication/jsonID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Condições para validação de atributos do usuário. Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.
Conjunto de itens que devem ser incluídos na compra para aplicar uma promoção. Se esse parâmetro for null, uma promoção será aplicada a todas as compras dentro de um projeto.
Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]
Exemplo: [12,789]
Nome da promoção. Deve conter pares chave/valor onde chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e o valor é uma cadeia de caracteres.
Exemplo: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção.
A promoção se aplica apenas a itens cujo preço atenda a todas as condições da matriz. Se você passar essa matriz, defina o valor do objeto condition como null.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/promotion/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [
{
"quantity": 50000,
"sku": "com.xsolla.mp_credits"
}
],
"condition": [
{
"sku": "com.xsolla.year_1_season_pass"
}
],
"name": {
"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'Resposta
application/json
{ "promotion_id": 2384756 }
Pedido
Exclui a promoção bônus. A promoção excluída:
- Desaparece da lista de promoções configuradas no seu projeto.
- Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode obter itens bônus com esta promoção.
Após a exclusão, a promoção não poderá ser restaurada.
Segurança
basicAuth
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonusCatá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