# LiveOps API # Overview * **Version:** 2.0.0 * **Servers**: `https://store.xsolla.com/api` * **[Contact Us by Email](mailto:integration@xsolla.com)** * **Contact URL:** https://xsolla.com/ * **Required TLS version:** 1.2 LiveOps is a toolkit for driving ongoing player engagement through promotions and personalized offers. Use the API to manage the following features: * **Promotions** — create and manage coupons, promo codes, discounts, and bonus campaigns. * **Personalization** — specify the conditions for displaying the item catalog and applying promotions only for certain authorized users. * **Promotion limits** — set a limit on how many times a promotion can be used by a user and configure scheduled resets for these limits. * **Reward chains & Value points** — configure reward progressions tied to value point accumulation. * **Daily chains** — set up recurring daily rewards to motivate regular logins. * **Offer chains** — build sequential purchase offers with per-step pricing and free reward options. * **Upsell** — a sales method in which the user is offered to buy an item with additional value. ## API calls The API is divided into the **following groups**: * **Admin** — calls for creating, updating, activating, and deleting campaigns and chain configurations. Authenticated via [basic access authentication](https://developers.xsolla.com/zh/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials. * **Client** — calls for retrieving available promotions, getting active chains, redeeming codes, and claiming rewards on behalf of authenticated end users. Authenticated via user JWT. # Authentication API calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call. ## Authentication using user's JWT User's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/zh/api/login/authentication-schemes#getting-user-token). The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token). ## Basic HTTP authentication Basic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/zh/api/getting-started/#api_keys_overview) is typically used.
Note

The API key is confidential and must not be stored or used in client applications.
With basic server-side authentication, all API requests must include the following header: - for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64 - for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64 You can find the parameter values in [Publisher Account](https://publisher.xsolla.com/): - `merchant_id` is displayed: - In **Company settings > Company**. - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`. - `project_id` is displayed: - Next to the project name in Publisher Account. - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`. - `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections: - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
For more information about working with API keys, see the [API references](/zh/api/getting-started/#api_keys_overview). ## Authentication with guest access support The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token). 2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers: - `x-unauthorized-id` with a request ID - `x-user` with the user's email address encoded in Base64 ## Useful links - [API calls by interaction model](https://developers.xsolla.com/zh/api/catalog/) - [Endpoint types](https://developers.xsolla.com/zh/api/catalog/) - [Errors handling](https://developers.xsolla.com/zh/api/catalog/) - [API keys](https://developers.xsolla.com/zh/api/catalog/) # Core entity structure Items of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.
Note

Some calls may include additional fields but they don't change the basic structure.
**Identification** - `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/) - `project_id` — project ID in Publisher Account - `sku` — item SKU, unique within the project **Store display** - `name` — item name - `description` — item description - `image_url` — image URL - `is_enabled` — item availability - `is_show_in_store` — whether the item is displayed in the catalog For more information about managing item availability in the catalog, see the [documentation](/zh/items-catalog/catalog-features/items-availability/). **Organization** - `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`) - `groups` — groups the item belongs to - `order` — display order in the catalog **Sale conditions** - `prices` — prices in real or virtual currency - `limits` — purchase limits - `periods` — availability periods - `regions` — regional restrictions **Example of core entity structure:** ```json { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://.../image.png", "name": { "en": "Crystals", "de": "Kristalle" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://.../image.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] } ``` # Basic purchase flow The Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/zh/api/catalog/section/authentication). The following example shows a basic flow for setting up and operating a store, from item creation to purchase. ## Create items and groups (Admin) Create an item catalog for your store, such as virtual items, bundles, or virtual currency. Example API calls: - [Create virtual item](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Create bundle](/zh/api/catalog/bundles-admin/admin-create-bundle) - [Create virtual currency](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency) ## Set up promotions, chains, and limits (Admin) Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains. Example API calls: - [Create bonus promotion](/zh/api/liveops/promotions-bonuses/create-bonus-promotion) - [Create daily reward](/zh/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Create unique catalog offer promotion](/zh/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer) ## Get item information (Client) Configure item display in your application.
Notice

Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.

Example API calls: - [Get virtual items list](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Get item group list](/zh/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Get list of bundles](/zh/api/catalog/bundles-catalog/get-bundle-list) - [Get sellable items list](/zh/api/catalog/common-catalog/get-sellable-items)
Note

By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter "show_inactive_time_limited_items": 1 in the catalog request.
## Sell items You can sell items using the following methods: - Fast purchase — sell one SKU multiple times. - Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order. If an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/zh/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed. For free item purchase, use the [Create order with specified free item](/zh/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/zh/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status. ### Fast purchase Use the client-side API call to [create an order with a specified item](/zh/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.
Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.
### Cart purchase Cart setup and purchase can be performed on the client or on the server side. **Set up and purchase a cart on the client** Implement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known. Implement the following cart logic: 1. After the player has filled a cart, use the [Fill cart with items](/zh/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items). 2. Update the cart contents based on user actions: - To add an item or change item quantity, use the [Update cart item by cart ID](/zh/api/shop-builder/operation/put-item-by-cart-id/) API call. - To remove an item, use the [Delete cart item by cart ID](/zh/api/shop-builder/operation/delete-item-by-cart-id/) API call.
Note

To get the current status of the cart, use the Get current user's cart API call.
3. Use the [Create order with all items from current cart](/zh/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default. **Set up and purchase a cart on the server** This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls. Implement the following cart logic: 1. After the player has filled a cart, use the [Fill cart with items](/zh/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items). 2. Use the [Create order with all items from current cart](/zh/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default. ## Open payment UI Use the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/zh/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui). | Action | Endpoint | |:--------------------------------|:--------------------------------------------------------------------------| | Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} | | Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards. After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users). Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.
To enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default. Possible order statuses: - `new` — order created - `paid` — payment received - `done` — item delivered - `canceled` — order canceled - `expired` — payment expired Track order status using one of the following methods: - [webhooks configured on your server](/zh/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) - [short-polling](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling) - [WebSocket API](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api) ## Useful links - Authentication - [API calls by interaction model](/zh/api/catalog/section/authentication) - [Payment testing](/zh/dev-resources/testing/general-info/#general_overview) - [Set up order status tracking](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking) - [Webhooks](/zh/webhooks/overview) - [Rate limits](/zh/api/login/rate-limits) - [Errors handling](/zh/api/getting-started/#api_errors_handling) - [API keys](/zh/api/getting-started/#api_keys_overview) # Pagination API calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially. Use the following parameters to control the number of returned items: - `limit` — number of items per page - `offset` — index of the first item on the page (numbering starts from 0) - `has_more` — indicates whether another page is available - `total_items_count` — total number of items Example request: ``` GET /items?limit=20&offset=40 ``` Response example: ```json { "items": [...], "has_more": true, "total_items_count": 135 } ``` It is recommended to send subsequent requests until the response returns `has_more = false`. # Date and time format Dates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The following are supported: - UTC offset - `null` value when there is no time restriction for displaying an item - [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields Format: `YYYY-MM-DDTHH:MM:SS±HH:MM` Example: `2026-03-16T10:00:00+03:00` # Localization Xsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/zh/doc/shop-builder/references/supported-languages/). **Supported fields** Localization can be specified for the following parameters: - `name` - `description` - `long_description` **Locale format** The locale key can be specified in one of the following formats: - Two-letter language code: `en`, `ru` - Five-letter language code: `en-US`, `ru-RU`, `de-DE` **Examples** Example with a two-letter language code: ```json { "name": { "en": "Starter Pack", "ru": "Стартовый набор" } } ``` Example with a five-letter language code: ```json { "description": { "en-US": "Premium bundle", "de-DE": "Premium-Paket" } } ``` # Error response format If an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/zh/dev-resources/references/errors/store-errors/). **Response example:** ```json { "errorCode": 1102, "errorMessage": "Validation error", "statusCode": 422, "transactionId": "c9e1a..." } ``` - `errorCode` — error code. - `errorMessage` — short error description. - `statusCode` — HTTP response status. - `transactionId` — request ID. Returned only in some cases. - `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases. **Extended response example:** ```json { "errorCode": 7001, "errorMessage": "Chain not found", "errorMessageExtended": { "chain_id": "test_chain_id", "project_id": "test_project_id", "step_number": 2 }, "statusCode": 404 } ``` **Common HTTP status codes** - `400` — invalid request - `401` — authentication error - `403` — insufficient permissions - `404` — resource not found - `422` — validation error - `429` — rate limit exceeded **Recommendations** - Handle the HTTP status and the response body together. - Use `errorCode` to process errors related to application logic. - Use `transactionId` to identify requests more quickly when analyzing errors. Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### AuthForCart The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`. Alternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token). 2. Simplified mode without `Authorization` header. This mode is used only for unauthorized users and can be applied only for [selling game keys](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers: * `x-unauthorized-id` with a request ID * `x-user` with the user’s email address encoded in Base64. Type: http Scheme: bearer ### XsollaLoginUserJWT Client-side calls use the `XsollaLoginUserJWT` authentication scheme. The request must include the user's JWT in the `Authorization` header in the following format: Bearer ``. The token identifies the user and provides access to personalized data. For details on how to create a token, refer to the [Xsolla Login API documentation](/zh/api/login/authentication-schemes#getting-user-token). You can try this call using the following test token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`. Alternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token). Type: http Scheme: bearer Bearer Format: JWT ### basicAuth Server-side calls use the `basicAuth` authentication scheme. All requests to API must contain the `Authorization: Basic ` header, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded according to the Base64 standard. You can use `merchant_id` instead of `project_id` if you need. It doesn't affect functionality. Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters: * `merchant_id` is shown: * In the **Company settings > Company** section * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`. * `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section: * [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) * [Project settings > API keys](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **Notice** If a required API call doesn't include the `project_id` path parameter, use an API key that is valid across all company projects for authorization. {% /html %} * `project_id` is shown: * In Publisher Account next to the name of the project. * In the URL in the browser address bar when working on project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`. For more information about working with API keys, see the [API reference](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### basicMerchantAuth Server-side calls use the `basicMerchantAuth` authentication scheme. All requests to API must contain the `Authorization: Basic ` header, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded according to the Base64 standard. Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters: * `merchant_id` is shown: * In the **Company settings > Company** section * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/` * `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) section. For more information about working with API keys, see the [API reference](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [LiveOps API](https://developers.xsolla.com/_bundle/@l10n/zh/api/liveops/index.yaml) ## Common API calls You can call API methods from this subsection to manage different types of promotions. ### 激活促销活动 - [PUT /v2/project/{project_id}/admin/promotion/{promotion_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-common/activate-promotion.md): 激活促销活动。 ### 停用促销活动 - [PUT /v2/project/{project_id}/admin/promotion/{promotion_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-common/deactivate-promotion.md): 停用促销活动。 ### 验证促销码 - [GET /v2/project/{project_id}/promotion/code/{code}/verify](https://developers.xsolla.com/zh/api/liveops/promotions-common/verify-promotion-code.md): Determines if the code is a promo code or coupon code and if the user can apply it. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 获取所有促销活动列表 - [GET /v3/project/{project_id}/admin/promotion](https://developers.xsolla.com/zh/api/liveops/promotions-common/get-promotion-list.md): 获取项目的促销活动列表。 ### 通过代码获取兑换型促销活动 - [GET /v3/project/{project_id}/admin/promotion/redeemable/code/{code}](https://developers.xsolla.com/zh/api/liveops/promotions-common/get-redeemable-promotion-by-code.md): 通过促销码或优惠券码获取促销活动。 ## 优惠券 Call API methods from this subsection to configure and manage coupon promotions.

Note

Refer to our documentation for detailed information about coupons.

### 获取唯一优惠券码限制 - [GET /v2/project/{project_id}/admin/code/limit/coupon/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-code-limit.md): 获取代码可以使用的剩余次数。要筛选代码，请使用codes查询参数。 要配置代码限制本身，请前往“管理”部分： *优惠券 ### 激活优惠券促销活动 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/activate-coupon.md): 激活优惠券促销活动。 默认情况下创建的优惠券促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活优惠券促销活动。 ### 获取优惠券码 - [GET /v2/project/{project_id}/admin/coupon/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-codes.md): 获取优惠券码。 ### 创建优惠券码 - [POST /v2/project/{project_id}/admin/coupon/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/create-coupon-code.md): 创建优惠券码。 ### 生成优惠券码 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/generate-coupon-codes.md): 生成优惠券码。 ### 停用优惠券促销活动 - [PUT /v2/project/{project_id}/admin/coupon/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/deactivate-coupon.md): 停用优惠券促销活动。 默认情况下创建的优惠券促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用优惠券促销活动。 ### 获取指定用户的优惠券限制 - [GET /v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-user-limit.md): 获取指定用户可以使用优惠券的剩余次数。 用户限制API允许您限制用户可以使用优惠券的次数。要配置用户限制数本身，请前往“管理”部分： * 优惠券 ### 获取优惠券奖励 - [GET /v2/project/{project_id}/coupon/code/{coupon_code}/rewards](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon-rewards-by-code.md): Gets coupons rewards by its code. Can be used to allow users to choose one of many items as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus (type=unit). Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 兑换优惠券码 - [POST /v2/project/{project_id}/coupon/redeem](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/redeem-coupon.md): Redeems a coupon code. The user gets a bonus after a coupon is redeemed. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 获取优惠券促销活动列表 - [GET /v3/project/{project_id}/admin/coupon](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupons.md): 获取项目的优惠券促销活动列表。 ### 创建优惠券促销活动 - [POST /v3/project/{project_id}/admin/coupon](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/admin-create-coupon.md): 创建优惠券促销活动。 ### 删除优惠券促销活动 - [DELETE /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/delete-coupon-promotion.md): 删除优惠券促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录。用户无法通过该促销活动获得奖励商品。 删除后，该促销活动无法恢复。 已删除促销活动的优惠券代码可以添加到现有的促销活动。 ### 获取优惠券促销活动 - [GET /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/get-coupon.md): 获取指定的优惠券促销活动。 ### 更新优惠券促销活动 - [PUT /v3/project/{project_id}/admin/coupon/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-coupons/update-coupon-promotion.md): 更新优惠券促销活动。 ## 促销码 Call API methods from this subsection to configure and manage promo code promotions.

Note

Refer to our documentation for detailed information about promo codes.

### 获取代码的促销码限制 - [GET /v2/project/{project_id}/admin/code/limit/promocode/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-code-limit.md): 获取代码可以使用的剩余次数。要筛选代码，请使用codes查询参数。 要配置代码限制本身，请前往“管理”部分： *促销码 ### 激活促销码活动 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/activate-promo-code.md): 激活促销码活动。 默认情况下创建的促销码活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活促销码活动。 ### 获取促销码活动的促销码 - [GET /v2/project/{project_id}/admin/promocode/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promocode-codes.md): 获取促销码活动的促销码。 ### 创建促销码活动的促销码 - [POST /v2/project/{project_id}/admin/promocode/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/create-promo-code-code.md): 为促销码活动创建促销码。 ### 生成促销码活动的促销码 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/generate-promo-code-codes.md): 生成促销码活动的促销码。 ### 停用促销码活动 - [PUT /v2/project/{project_id}/admin/promocode/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/deactivate-promo-code.md): 停用促销码活动。 默认情况下创建的促销码活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用促销码活动。 ### 获取指定用户的促销码限制 - [GET /v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-user-limit.md): 获取指定用户可以使用促销码的剩余次数。 用户限制API允许您限制用户可以使用促销码的次数。要配置用户限制数本身，请前往“管理”部分： * 促销码 ### 获取促销码奖励 - [GET /v2/project/{project_id}/promocode/code/{promocode_code}/rewards](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code-rewards-by-code.md): Gets promo code rewards by its code. Can be used to allow users to choose one of many items as a bonus. The usual case is choosing a DRM if the promo code contains a game as a bonus (type=unit). Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 兑换促销码 - [POST /v2/project/{project_id}/promocode/redeem](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/redeem-promo-code.md): 兑换促销码活动的促销码。 兑换促销码后，用户将获得免费商品和/或购物车和/或特定商品的价格折扣。 ### 移除购物车的促销码 - [PUT /v2/project/{project_id}/promocode/remove](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/remove-cart-promo-code.md): 移除购物车的促销码。 删除促销码后，将重新计算购物车中所有商品的总价，去掉促销码提供的奖励和折扣。 ### 获取促销码活动列表 - [GET /v3/project/{project_id}/admin/promocode](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-codes.md): 获取项目的促销码列表。 ### 创建促销码活动 - [POST /v3/project/{project_id}/admin/promocode](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/create-promo-code.md): 创建促销码活动。 ### 删除促销码活动 - [DELETE /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/delete-promo-code.md): 删除促销码活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品或购买商品。 删除后，该促销活动无法恢复。 已删除促销活动的促销码可以添加到现有的促销活动。 ### 获取促销码活动 - [GET /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/get-promo-code.md): 获取指定的促销码活动。 ### 更新促销码活动 - [PUT /v3/project/{project_id}/admin/promocode/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes/update-promo-code.md): 更新促销码活动。 ## 特别目录优惠 Call API methods from this subsection to configure and manage unique catalog offers.

Note

Refer to our documentation for detailed information about unique offers.

### 激活特别目录优惠促销活动 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/activate-unique-catalog-offer.md): 激活特别目录优惠促销活动。 默认情况下创建的特别目录促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点启用和激活优惠券促销活动。 ### 获取特别目录优惠代码 - [GET /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offer-codes.md): 获取特别目录优惠代码。 ### 创建特别目录优惠代码 - [POST /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/create-unique-catalog-offer-code.md): 创建特别目录优惠代码。 ### 生成特别目录优惠代码 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/generate-unique-catalog-offer-codes.md): 生成特别目录优惠代码。 ### 停用特别目录优惠促销活动 - [PUT /v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/deactivate-unique-catalog-offer.md): 停用特别目录优惠促销活动。 默认情况下创建的特别目录促销活动为禁用状态。 激活之前，不能进行兑换。 使用此端点禁用和停用优惠券促销活动。 ### 获取特别目录优惠促销活动列表 - [GET /v3/project/{project_id}/admin/unique_catalog_offer](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offers.md): 获取项目的特别目录优惠促销活动的列表。 ### 创建特别目录优惠促销活动 - [POST /v3/project/{project_id}/admin/unique_catalog_offer](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer.md): 创建一个特别目录优惠促销活动。 ### 删除特别目录优惠促销活动 - [DELETE /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/delete-unique-catalog-offer-promotion.md): 删除特别目录优惠促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。 删除后，该促销活动无法恢复。 ### 获取特别目录优惠促销活动 - [GET /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/get-unique-catalog-offer.md): 获取指定的特别目录优惠促销活动。 ### 更新特别目录优惠促销活动 - [PUT /v3/project/{project_id}/admin/unique_catalog_offer/{external_id}](https://developers.xsolla.com/zh/api/liveops/promotions-unique-catalog-offers/update-unique-catalog-offer-promotion.md): 更新特别目录优惠促销活动。 ## 折扣 Call API methods from this subsection to configure and manage discount promotions.

Note

Refer to our documentation for detailed information about discounts.

### 获取商品促销活动列表 - [GET /v3/project/{project_id}/admin/promotion/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/get-item-promotion-list.md): 获取项目的商品促销列表。 促销活动提供商品折扣(%)。 折扣应用于指定商品的所有价格。 ### 为商品创建折扣促销活动 - [POST /v3/project/{project_id}/admin/promotion/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/create-item-promotion.md): 为商品创建折扣促销活动。 促销活动提供商品折扣(%)。 折扣将应用于指定商品的所有价格。 ### 删除商品促销活动 - [DELETE /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/delete-item-promotion.md): 删除折扣促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消失。 * 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。 删除后，该促销活动无法恢复。 ### 获取商品促销活动 - [GET /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/get-item-promotion.md): 获取应用于特定商品的促销活动。 促销提供商品折扣 (%)。 折扣将应用于指定商品的所有价格。 ### 更新商品促销活动 - [PUT /v3/project/{project_id}/admin/promotion/{promotion_id}/item](https://developers.xsolla.com/zh/api/liveops/promotions-discounts/update-item-promotion.md): 更新促销活动。 注意新数据将替换旧数据。如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。 促销提供商品折扣(%)。 折扣将应用于指定商品的所有价格。 ## 奖励 Call API methods from this subsection to configure and manage bonus promotions.

Note

Refer to our documentation for detailed information about bonuses.

### 获取奖励促销活动列表 - [GET /v3/project/{project_id}/admin/promotion/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/get-bonus-promotion-list.md): 获取项目的奖励促销活动列表。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 创建奖励促销活动 - [POST /v3/project/{project_id}/admin/promotion/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/create-bonus-promotion.md): 创建奖励促销活动。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 删除奖励促销活动 - [DELETE /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/delete-bonus-promotion.md): 删除奖励促销活动。删除的促销活动将： * 从您项目中设置的促销活动列表中消。失 * 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品。 删除后，该促销活动无法恢复。 ### 获取奖励促销活动 - [GET /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/get-bonus-promotion.md): 获取奖励促销活动。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ### 更新奖励促销活动 - [PUT /v3/project/{project_id}/admin/promotion/{promotion_id}/bonus](https://developers.xsolla.com/zh/api/liveops/promotions-bonuses/update-bonus-promotion.md): 更新促销活动。 注意如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。 促销活动对进行购买的用户给予免费的奖励商品。 促销活动可以应用于项目中的任何购买或包含特定商品的购买。 ## 个性化目录 Personalization allows you to specify the conditions for displaying the item catalog and applying promotions only for specific authorized users. Conditions are defined based on user attributes and allow you to offer items and promotions that are most relevant to particular users. The following personalization types are available: * [Xsolla-side personalization](/zh/liveops/promotion-tools/personalization/#guides_personalization_on_xsolla_side). Personalization rules and logic are configured and stored on the Xsolla side. You pass user attributes, and Xsolla uses them to generate a personalized catalog. * [Partner-side personalization](/zh/liveops/promotion-tools/personalization/#guides_personalization_on_partner_side). You configure personalization rules and logic on your side and send a final catalog payload for a specific user to Xsolla.
Note

You can use only one personalization type. To change it, follow the instructions.
To configure personalization on the Xsolla side using the Xsolla API: 1. Create items using the API calls from the **Admin** subsection of the [Virtual items and currency](/zh/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/zh/api/catalog/bundles-admin/admin-create-bundle) or [Game keys](/zh/api/catalog/game-keys-admin) groups. 2. [Set up user attributes using the Xsolla Login API](/zh/liveops/promotion-tools/personalization/#web_shop_guide_personalization_setting_attributes) and keep them synchronized by updating data in Xsolla whenever changes occur in your game. 3. Configure personalization for items or promotions: * To personalize the item catalog, define catalog display rules using the [Create catalog filter rule](/zh/api/liveops/personalized-catalog/create-filter-rule) API call: * In the [attribute_conditions](/zh/api/liveops/personalized-catalog/create-filter-rule#personalized-catalog/create-filter-rule/t=request&path=attribute_conditions) array, specify the conditions that determine item availability based on user attributes. * In the [items](/zh/api/liveops/personalized-catalog/create-filter-rule#personalized-catalog/create-filter-rule/t=request&path=items) array, provide the list of items that should be visible to the user if their attributes match the specified conditions. * To configure personalized promotions, use the [create and update API calls for the required promotion type](/zh/api/liveops/promotions-discounts/create-item-promotion). In the [attribute_conditions](/zh/api/liveops/promotions-discounts/create-item-promotion) array, specify the conditions that determine promotion availability based on user attributes. 4. Pass the [user JWT](/zh/api/login/getting-user-token#getting-user-token) with user attributes to the [catalog retrieval API calls](https://developers.xsolla.com/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items) to receive a personalized catalog. **Sequence for configuring and applying Xsolla-side personalization for item catalog:** ![Personalization for item catalog](https://cdn.xsolla.net/developers/current/images/api_docs/personalization-catalog.png) **Sequence for configuring and applying Xsolla-side personalization for promotions:** ![Personalization for promotions](https://cdn.xsolla.net/developers/current/images/api_docs/personalization-liveops.png)
Note

Detailed information is provided:
### 获取目录筛选规则列表 - [GET /v2/project/{project_id}/admin/user/attribute/rule](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-filter-rules.md): 获取应用于用户属性的所有规则。 ### 创建目录筛选规则 - [POST /v2/project/{project_id}/admin/user/attribute/rule](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/create-filter-rule.md): 创建用户属性的规则。 ### 获取所有目录规则以供在客户端搜索 - [GET /v2/project/{project_id}/admin/user/attribute/rule/all](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-all-filter-rules.md): 获取所有目录规则列表以供在客户端搜索。 注意：仅返回规则ID、名称和is_enabled ### 删除目录筛选规则 - [DELETE /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/delete-filter-rule-by-id.md): 删除指定规则。 ### 获取目录筛选规则 - [GET /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/get-filter-rule-by-id.md): 获取应用于用户属性的指定规则。 ### 补丁目录筛选规则 - [PATCH /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/patch-filter-rule-by-id.md): 更新应用于用户属性的指定规则。当前值将用于未指定的属性。 ### 更新目录筛选规则 - [PUT /v2/project/{project_id}/admin/user/attribute/rule/{rule_id}](https://developers.xsolla.com/zh/api/liveops/personalized-catalog/update-filter-rule-by-id.md): 更新应用于用户属性的指定规则。默认值将用于未指定的属性（如果属性非必需）。 ## 管理 ### 刷新指定用户的所有促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/all](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/reset-all-user-promotions-limit.md): 刷新指定用户所有促销活动的所有限制，以便其可以再次使用这些促销活动。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 减少指定用户的促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/remove-user-promotion-limit.md): 减少指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 获取指定用户的促销活动限制 - [GET /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/get-user-promotion-limit.md): 获取指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 增加指定用户的促销活动限制 - [POST /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/add-user-promotion-limit.md): 增加指定用户在应用的限制内可以使用促销活动的剩余次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 设置指定用户的促销活动限制 - [PUT /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/set-user-promotion-limit.md): 在增加或减少次数后设置指定用户在应用的限制内可以使用促销活动的次数。 用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ### 刷新用户的促销活动限制 - [DELETE /v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all](https://developers.xsolla.com/zh/api/liveops/user-limits-admin/reset-user-promotion-limit.md): 刷新促销活动限制以便用户可以再次使用该促销活动。如果user参数为null，此调用将刷新所有用户的此限制。 用户限制API允许您限制用户可以使用促销的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分： * 折扣促销活动 * 奖励促销活动 ## 管理 ### 获取奖励积分列表 - [GET /v2/project/{project_id}/admin/items/value_points](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-value-points-list.md): 获取项目内的奖励积分列表以用于管理。 ### 创建奖励积分 - [POST /v2/project/{project_id}/admin/items/value_points](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-create-value-points.md): 创建一个奖励积分。 ### 删除奖励积分 - [DELETE /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-value-point.md): 按SKU删除奖励积分。 ### 获取奖励积分 - [GET /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-value-point.md): 根据项目中的SKU获取奖励积分以进行管理。 ### 更新奖励积分 - [PUT /v2/project/{project_id}/admin/items/value_points/sku/{item_sku}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-update-value-point.md): 按SKU更新奖励积分。 ### 删除商品的奖励积分 - [DELETE /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-items-value-point-reward.md): 删除所有商品的奖励积分奖励。 ### 获取有奖励积分的商品列表 - [GET /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-items-value-point-reward.md): 获取项目内有奖励积分的商品列表以用于管理。 ### 部分更新商品的奖励积分 - [PATCH /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-patch-items-value-point-reward.md): 按照商品SKU来部分更新一个或多个商品的奖励积分数量。用户在购买指定商品后可获得这些奖励积分。 更新奖励积分的原则： * 如果某个商品尚无奖励积分，则在amount字段中发送非零值将创建奖励积分。 * 如果某个商品已有奖励积分，则在amount字段中发送非零值将更新原有值。 * 如果amount设置为0，则会删除该商品的现有奖励积分。 与PUT方法（设置商品的奖励积分）不同，此PATCH方法不会覆盖项目中所有商品的现有奖励积分，它只会更新指定的商品。 单个请求最多可以更新100个商品。同一请求中不能包含重复的商品SKU。 ### 设置商品的奖励积分 - [PUT /v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-set-items-value-point-reward.md): 按SKU将奖励积分分配给一件或多件商品。用户购买这些商品后将获得奖励积分。 请注意，此PUT请求将覆盖项目中商品所有先前设置的奖励积分。 为了避免无意中删除奖励积分，请在每个PUT请求中包含所有商品及其各自的奖励积分。 如果只想更新特定商品的奖励积分，同时保留其他商品的奖励积分，则应使用GET请求检索当前的奖励积分集，修改所需商品的奖励积分，然后返回包含特定商品更新后奖励积分的奖励积分集。 ### 获取奖励链列表 - [GET /v3/project/{project_id}/admin/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-reward-chains.md): 获取奖励链列表。 注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应10项。要逐页获取更多数据，请使用limit和offset字段。 ### 创建奖励链 - [POST /v3/project/{project_id}/admin/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-create-reward-chain.md): 创建奖励链。 ### 删除奖励链 - [DELETE /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-delete-reward-chain.md): 删除特定奖励链。 ### 获取奖励链 - [GET /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-get-reward-chain.md): 获取特定奖励链。 ### 更新奖励链 - [PUT /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-update-reward-chain.md): 更新特定奖励链。 ### 重置奖励链 - [POST /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-reset-reward-chain.md): Resets the value points balance and progress of all users in the reward chain. The balance is tied to the value points type, not to a specific reward chain. If these value points are used in other chains, the balance will be reset in all chains that use these value points. After the reset, you can update the reward chain’s validity period, and users will be able to progress through it again. The clan balance is calculated as the sum of its members’ balances. Therefore, after the reset, the clan balance is also reset. This request is irreversible and applies to all users of the project. Notice You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward. ### 开关奖励链 - [PUT /v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/reward-chain-value-points-admin/admin-toggle-reward-chain.md): 启用/禁用奖励链。 ## 客户端 ### 获取当前用户的奖励链 - [GET /v2/project/{project_id}/user/reward_chain](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/get-reward-chains-list.md): Client endpoint. Gets the current user’s reward chains. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 获取当前用户的奖励积分余额 - [GET /v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/get-user-reward-chain-balance.md): Client endpoint. Gets the current user’s value point balance. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 领取步骤奖励 - [POST /v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim](https://developers.xsolla.com/zh/api/liveops/reward-chain-client/claim-user-reward-chain-step-reward.md): Client endpoint. Claims the current user’s step reward from a reward chain. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 公会客户端 ### 获取公会名下奖励链的前10名贡献者列表 - [GET /v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top](https://developers.xsolla.com/zh/api/liveops/clan-reward-chain-client/get-user-clan-top-contributors.md): Retrieves the list of top 10 contributors to the specific reward chain under the current user's clan. If a user doesn't belong to a clan, the call returns an empty array. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 更新当前用户的公会 - [PUT /v2/project/{project_id}/user/clan/update](https://developers.xsolla.com/zh/api/liveops/clan-reward-chain-client/user-clan-update.md): Updates a current user's clan via user attributes. Claims all rewards from reward chains that were not claimed for a previous clan and returns them in the response. If the user was in a clan and now is not — their inclusion in the clan will be revoked. If the user changed the clan — the clan will be changed. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 管理 ### 获取每日奖励列表 - [GET /v2/project/{project_id}/admin/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-get-daily-chains.md): 获取每日奖励列表以进行管理。 注意此方法返回分页的商品列表。最大值和默认值为每个响应50项。如要从列表中获取更多项，请使用limit和offset参数并获取更多页。例如，当使用limit = 25和offset = 100调用方法时，响应将从整体列表中的第101项开始返回25项。 ### 创建每日奖励 - [POST /v2/project/{project_id}/admin/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-create-daily-chain.md): 创建每日奖励。 ### 删除每日奖励 - [DELETE /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-delete-daily-chain.md): 删除指定每日奖励。 ### 获取每日奖励 - [GET /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-get-daily-chain.md): 获取指定每日奖励以用于管理。 ### 更新每日奖励 - [PUT /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-update-daily-chain.md): 更新指定每日奖励。 ### 重置每日奖励 - [POST /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-reset-daily-chain.md): 重置所有用户的每日奖励进度。仅适用于rolling类型每日奖励。 ### 切换每日奖励 - [PUT /v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/daily-chain-admin/admin-toggle-daily-chain.md): 启用或禁用每日奖励。 ## 客户端 ### 获取当前用户的每日奖励 - [GET /v2/project/{project_id}/user/daily_chain](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/get-daily-chains-list.md): Client endpoint. Gets the current user's daily rewards. NoticeA method returns a paginated list of items. The maximum and default value is 50 items per response. To get more items from the list, use the limit and offset parameters and fetch more pages. For example, when calling a method with limit = 25 and offset = 100, the response returns 25 items starting from the 101st item in the overall list. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 通过ID获取当前用户的每日奖励 - [GET /v2/project/{project_id}/user/daily_chain/{daily_chain_id}](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/get-user-daily-chain-by-id.md): Client endpoint. Gets the current user’s daily reward by its ID. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 领取每日奖励步骤 - [POST /v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim](https://developers.xsolla.com/zh/api/liveops/daily-chain-client/claim-user-daily-chain-step-reward.md): Client endpoint. Claims the current user's step reward from a daily reward. All steps can only be claimed in sequential order. The reward for a missed step cannot be obtained for virtual or real currency, or by watching an ad Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 管理 ### 获取优惠链列表 - [GET /v2/project/{project_id}/admin/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-get-offer-chains.md): 获取优惠链列表以用于管理。 注意所有项目的单次响应中返回的商品数量都有上限。默认值和最大值为每次响应10个商品。如需更多数据，可通过limit与offset参数分页获取。 ### 创建优惠链 - [POST /v2/project/{project_id}/admin/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-create-offer-chain.md): 创建优惠链。 ### 删除优惠链 - [DELETE /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-delete-offer-chain.md): 删除指定优惠链。 删除后：用户已收到的奖励保留。未完成步骤不再可用，不可再获取奖励。 与通过启停优惠链禁用优惠链不同，删除不可恢复，用户进度不保留。 ### 获取优惠链 - [GET /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-get-offer-chain.md): 获取指定优惠链以用于管理。 ### 更新优惠链 - [PUT /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-update-offer-chain.md): 更新指定优惠链。 ### 启停优惠链 - [PUT /v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle](https://developers.xsolla.com/zh/api/liveops/offer-chain-admin/admin-toggle-offer-chain.md): 启用/禁用优惠链。 禁用后，用户暂时无法访问，但进度保留。 重新启用后，用户可从上次步骤的进度继续。 ## 客户端 ### 获取当前用户的优惠链 - [GET /v2/project/{project_id}/user/offer_chain](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/get-offer-chains-list.md): Gets the current user’s offer chains. NoticeAll projects have a limit on the number of items that can be returned in a single response. The default and maximum value is 30 items per response. To get more data, use the limit and offset query parameters for pagination. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 根据ID获取当前用户的优惠链 - [GET /v2/project/{project_id}/user/offer_chain/{offer_chain_id}](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/get-user-offer-chain-by-id.md): Gets the current user’s offer chain by the offer chain's ID. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 领取免费优惠链步骤奖励 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/claim-user-offer-chain-step-reward.md): Completes the current user’s progression through the offer chain step and grants the associated reward. Notice Use this call only for free steps in the offer chain. For steps that require payment in real currency, use the Create order for paid offer chain step call instead. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 为付费优惠链步骤创建订单 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/order-user-offer-chain-step-reward.md): Creates an order for the item associated with the specified paid offer chain step. The created order gets the new order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation4/?token={token}, where {token} is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Notice This method must be used on the client side. The user's IP address is used to determine the country, which affects the currency and available payment methods. Using this method from the server side may result in incorrect currency detection and affect payment methods in Pay Station. Notice Use this call only for paid offer chain steps. For free steps, use the Claim free offer chain step call instead. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## payment-client-side ### 为付费优惠链步骤创建订单 - [POST /v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order](https://developers.xsolla.com/zh/api/liveops/offer-chain-client/order-user-offer-chain-step-reward.md): Creates an order for the item associated with the specified paid offer chain step. The created order gets the new order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation4/?token={token}, where {token} is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Notice This method must be used on the client side. The user's IP address is used to determine the country, which affects the currency and available payment methods. Using this method from the server side may result in incorrect currency detection and affect payment methods in Pay Station. Notice Use this call only for paid offer chain steps. For free steps, use the Claim free offer chain step call instead. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 管理 ### 获取项目中追加销售的信息 - [GET /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/get-upsell-configurations-for-project-admin.md): 检索项目中追加销售的信息：是否启用、追加销售的类型以及属于此追加销售的商品SKU列表。 ### 创建追加销售 - [POST /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/post-upsell.md): Creates an upsell for a project. Notice This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 更新追加销售 - [PUT /v2/project/{project_id}/admin/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-admin/put-upsell.md): Update an upsell for a project. Notice This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ### 激活/停用项目的追加销售 - [PUT /v2/project/{project_id}/admin/items/upsell/{toggle}](https://developers.xsolla.com/zh/api/liveops/upsell-admin/put-upsell-toggle-active-inactive.md): Changes an upsell’s status in a project to be either active or inactive. Notice This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 客户端 ### 获取项目中追加销售商品的列表 - [GET /v2/project/{project_id}/items/upsell](https://developers.xsolla.com/zh/api/liveops/upsell-client/get-upsell-for-project-client.md): Gets a list of upsell items in a project if they have already been set up. Note This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.