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

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
region_idintegerобязательный

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

Пример: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/region/42

Ответы

Регион успешно удален.

Тело
Ответ
Нет содержимого

Получение регионаServer-sideAdmin

Запрос

Получает определенный регион.

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

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

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

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

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

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

Ответы

Указанный регион успешно получен.

Телоapplication/json
countriesArray of strings(Regions_countries)

Список стран, которые необходимо добавить в регион.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

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

Пример: 42
nameobject(Regions_name)

Название региона. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

По умолчанию {"de-DE":"Asien","en-US":"Asia"}
Пример: {"de-DE":"Asien","en-US":"Asia"}
Ответ
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

Обновление регионаServer-sideAdmin

Запрос

Обновляет определенный регион.

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

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

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

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

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

Пример: 42
Телоapplication/json
countriesArray of strings(Regions_countries)обязательный

Список стран, которые необходимо добавить в регион.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: ["JP", "CN", "VN"]

nameobject(Regions_name)обязательный

Название региона. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

По умолчанию {"de-DE":"Asien","en-US":"Asia"}
Пример: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringдополнительное свойство
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Ответы

Регион успешно обновлен.

Тело
Ответ
Нет содержимого
Операции
Операции
Операции
Операции

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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