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

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 Платежей Иксолла.

Операции

Получение списка правил фильтрации каталогаServer-sideAdmin

Запрос

Получает все правила, применяемые к атрибутам пользователя.

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

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

Пример: 44056
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
is_enabledinteger

Фильтрует элементы по флагу is_enabled.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'

Ответы

Правила успешно получены.

Телоapplication/json
has_moreboolean

Существует ли другая страница с правилами.

itemsArray of objects(user-attribute_personalized-catalog)
total_items_countnumber

Общее количество правил.

Ответ
application/json
{ "has_more": true, "items": [ {} ], "total_items_count": 20 }

Создание правила фильтрации каталогаServer-sideAdmin

Запрос

Создает правило для пользовательских атрибутов.

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

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

Пример: 44056
Телоapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsобязательный

Условия для проверки атрибутов пользователя. Определяют доступность товаров в каталоге на основе соответствия атрибутов пользователя всем указанным условиям.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$обязательный

Код атрибута пользователя.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Считается ли условие выполненным, если этот атрибут отсутствует в атрибутах пользователя. Передайте true, чтобы показывать товар пользователям, у которых нет этого атрибута. Пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, не увидят товар. false — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)обязательный

Тип операции, выполняемой по условию. Для типа атрибута string.

Перечисление ЗначениеОписание
eq

Равно

ne

Не равно

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)обязательный

Тип атрибута пользователя.

Значение"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 charactersобязательный

Значение условия, с которым будет сравниваться значение атрибута пользователя. Тип зависит от типа атрибута.

is_enabledbooleanобязательный

Включено ли данное правило.

is_satisfied_for_unauthboolean

Отображается ли товар неавторизованным пользователям. Если true, товар отображается неавторизованным пользователям независимо от правил отображения каталога. false по умолчанию.

itemsArray of objects[ 1 .. 100 ] itemsобязательный
One of:

Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.

items[].​item_idnumberобязательный

ID предмета (артикул).

namestring[ 1 .. 255 ] characters^\Sобязательный

Читаемое название правила. Используется для отображения правила в Личном кабинете.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Ответы

Правило успешно создано.

Телоapplication/json
rule_idnumber

ID правила.

Ответ
application/json
{ "rule_id": 1 }

Получение всех правил каталога для поиска на стороне клиентаServer-sideAdmin

Запрос

Получает список всех правил каталога для поиска на стороне клиента.

Внимание

Возвращает только ID правила, имя и is_enabled
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/user/attribute/rule/all

Ответы

Правила успешно получены.

Телоapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Ответ
application/json
{ "items": [ {}, {} ] }
Операции
Операции

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

Операции

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

Операции

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

Операции

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

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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