Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.
Запрос
Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из конкретной корзины и генерирует для него токен оплаты. Созданный заказ получает статус заказа new.
IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.
Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Поскольку этот метод использует IP-адрес для определения страны пользователя и выбора валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/payment/cart/{cart_id}
- https://store.xsolla.com/api/v2/project/{project_id}/payment/cart/{cart_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/payment/cart/custom_id \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"custom_parameters": {
"character_id": "ingameUsername"
},
"sandbox": true,
"settings": {
"ui": {
"desktop": {
"header": {
"close_button": false,
"is_visible": true,
"type": "normal",
"visible_logo": true,
"visible_name": true,
"visible_purchase": true
}
},
"theme": "63295a9a2e47fab76f7708e1"
}
}
}'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Запрос
Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа new.
IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.
Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Поскольку этот метод использует IP-адрес для определения страны пользователя и выбора валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/payment/item/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/payment/item/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/payment/item/booster_mega_1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"custom_parameters": {
"character_id": "ingameUsername"
},
"promo_code": "discount_code",
"quantity": 5,
"sandbox": true,
"settings": {
"ui": {
"desktop": {
"header": {
"close_button": false,
"is_visible": true,
"type": "normal",
"visible_logo": true,
"visible_name": true,
"visible_purchase": true
}
},
"theme": "63295a9a2e47fab76f7708e1"
}
}
}'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Запрос
Создает заказ на товар, связанный с указанным уровнем цепочки предложений. Полученный заказ получает статус new.
Чтобы открыть платежный интерфейс в новом окне, используйте ссылку: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Используйте этот метод только на стороне клиента. Метод определяет страну пользователя по IP-адресу, чтобы применить соответствующую валюту и доступные способы оплаты. Вызов с сервера может привести к некорректному определению валюты и повлиять на способы оплаты в Pay Station.
Используйте только для получения наград на платных уровнях цепочки предложений. Для платных используйте метод Получение награды за уровень цепочки предложений.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order
- https://store.xsolla.com/api/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/order \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }