- Obter promoção de oferta de catálogo exclusiva
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.
Pedido
Exclui a promoção de oferta de catálogo único. 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 comprar itens com esta promoção.
Após a exclusão, a promoção não poderá ser restaurada.
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/unique_catalog_offer/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/unique_catalog_offer/{external_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/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1ID 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/unique_catalog_offer/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/unique_catalog_offer/{external_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/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1Oferta de catálogo exclusiva recebida com sucesso.
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.
Uma lista de itens SKU que estão disponíveis depois de usar a oferta de catálogo exclusivo.
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.
{ "external_id": "secret_shop", "is_enabled": true, "items": [ "helmet", "sword", "shield" ], "name": { "en-US": "Secret shop", "ru-RU": "Секретный магазин" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Uma lista de itens SKU que estão disponíveis depois de usar a oferta de catálogo exclusivo.
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.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/liveops/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1 \
-H 'Content-Type: application/json' \
-d '{
"items": [
"elven_sword",
"elven_boots"
],
"name": {
"de-DE": "Neujahrsangebot",
"en-US": "New Year Offer"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"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.