Перейти к содержимому

Overview

  • 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.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/
Операции

Персонализированный каталог

Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.

Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".

Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.

Операции
Операции
Операции

Корзина (на стороне клиента)

Операции

Корзина (на стороне сервера)

Операции

Оплата (на стороне клиента)

Операции

Оплата (на стороне сервера)

Операции
Операции
Операции
Операции
Операции
Операции

Catalog

Данный API позволяет получать продаваемые товары любого вида или конкретный товар.

Операции
Операции
Операции
Операции
Операции
Операции

Купоны

Этот API позволяет вам управлять купонами.

Операции

Промокоды

Этот API позволяет вам управлять промокодами.

Операции

Уникальный каталог предложений

Этот API позволяет вам управлять уникальными предложениями каталога.

Операции

Скидки

Этот API позволяет вам управлять скидочными акциями.

Операции

Бонусы

Этот API позволяет вам управлять бонусными акциями.

Операции
Операции
Операции
Операции
Операции

Уменьшение лимита акций для пользователяServer-sideAdmin

Запрос

Уменьшает оставшееся количество раз, когда указанный пользователь может воспользоваться рекламной акцией в пределах установленного лимита.

API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
promotion_idintegerобязательный

ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: 111425
Телоapplication/json
availableinteger(User-limit_available)>= 1обязательный

Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.

userobject(User-limit_user)обязательный
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$обязательный

External ID пользователя.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Ответы

Ограничения на продвижение для пользователя были успешно получены.

Телоapplication/json
per_userobject
Ответ
application/json
{ "per_user": { "available": 9, "total": 10 } }

Получение лимита акций для пользователяServer-sideAdmin

Запрос

Возвращает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.

API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
promotion_idintegerобязательный

ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: 111425
Запрос
user_external_idstringобязательный

External ID пользователя

Пример: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Ответы

Ограничения на продвижение для пользователя были успешно получены.

Телоapplication/json
per_userobject
Ответ
application/json
{ "per_user": { "available": 9, "total": 10 } }

Увеличение лимита акций для пользователяServer-sideAdmin

Запрос

Увеличивает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.

API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
promotion_idintegerобязательный

ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: 111425
Телоapplication/json
availableinteger(User-limit_available)>= 1обязательный

Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.

userobject(User-limit_user)обязательный
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$обязательный

External ID пользователя.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Ответы

Ограничения на продвижение для пользователя были успешно получены.

Телоapplication/json
per_userobject
Ответ
application/json
{ "per_user": { "available": 9, "total": 10 } }
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции