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

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 позволяет получать продаваемые товары любого вида или конкретный товар.

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

Получение кодовServer-sideAdmin

Запрос

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

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

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

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

Артикул товара.

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

Email-адрес пользователя.

Пример: user_email=email@email.com
quantityintegerобязательный

Количество кодов.

Пример: quantity=100
reasonstringобязательный

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

Пример: reason=Very important
region_idinteger

ID региона.

По умолчанию 1
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Ответы

Коды успешно получены.

Телоtext/plain
string
Ответ
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Загрузка кодов по IDServer-sideAdmin

Запрос

Загружает коды по ID игрового ключа.

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

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

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

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

Пример: 656
Телоmultipart/form-data
filestring(binary)обязательный

Файл с кодами.

Пример: "keys.txt"
region_idinteger

ID региона.

Пример: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

Ответы

Информация о сеансе загрузки кодов успешно получена.

Телоapplication/json
count_skippedinteger
Пример: 10
count_totalinteger
Пример: 100
count_uploadedinteger
Пример: 0
session_idstring
Пример: "fc7105b6e8ee01339582970b37697242"
statusstring
Пример: "processing"
Ответ
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

Получение информации о сеансе загрузки кодовServer-sideAdmin

Запрос

Получает информацию о сеансе загрузки кодов.

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

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

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

ID сеанса.

По умолчанию "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

Ответы

Информация о сеансе загрузки кодов успешно получена.

Телоapplication/json
count_skippedinteger
Пример: 10
count_totalinteger
Пример: 100
count_uploadedinteger
Пример: 0
session_idstring
Пример: "fc7105b6e8ee01339582970b37697242"
statusstring
Пример: "processing"
Ответ
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }
Операции

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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