LiveOps API (2.0.0)
- 版本: 2.0.0
- 服务器:
https://store.xsolla.com/api - 通过邮件联系我们
- 联系URL: https://xsolla.com/
- 必需的TLS版本: 1.2
LiveOps运营API是一套工具包,通过促销活动和个性化优惠推动玩家持续互动。
通过该API可管理以下功能:
- 促销活动 — 创建和管理优惠券、促销码、折扣及奖励活动。
- 个性化 — 指定商品目录显示和促销活动应用条件,仅面向特定授权用户。
- 促销活动限制 — 设置用户使用促销活动的次数限制,并配置限制的定期重置。
- 奖励链和奖励积分 — 配置与奖励积分累积关联的奖励进度。
- 每日奖励链 — 设置循环每日奖励,激励玩家定期登录。
- 优惠链 — 创建阶梯式连续购买优惠,每步提供不同定价和免费奖励选项。
- 追加销售 —向用户提供购买超值商品的销售方式。
API分为以下组别:
Admin — 用于创建、更新、激活和删除营销活动及奖励链配置。通过基本认证方式验证身份,需使用您的商户或项目凭据。Client — 用于检索可用促销活动、获取活跃奖励链、兑换码,以及代表最终用户(已完成身份认证)领取奖励。通过用户JWT进行身份认证。
下载 OpenAPI 描述
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/liveops/
- https://store.xsolla.com/api/v2/project/{project_id}/admin/code/limit/promocode/external_id/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/{project_id}/admin/code/limit/promocode/external_id/{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/v2/project/44056/admin/code/limit/promocode/external_id/coupon_44056_1?codes%5B%5D=string&limit=50&offset=0'响应
application/json
{ "has_more": false, "items": [ { … }, { … } ], "promotion_id": 1, "total_items_count": 2 }
- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{external_id}/activate
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/{project_id}/admin/promocode/{external_id}/activate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/promocode/coupon_44056_1/activate- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{external_id}/code
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/{project_id}/admin/promocode/{external_id}/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/v2/project/44056/admin/promocode/coupon_44056_1/code?limit=50&offset=0'响应
application/json
{ "codes": [ { … }, { … }, { … }, { … }, { … } ], "total_count": 5 }
个性化目录
此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件,则会显示个性化商品。
有关个性化促销活动的信息,请参阅促销活动部分。
要在购买前传递属性,您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性。
操作