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

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-side

Запрос

Генерирует заказ и платежный токен для него. Заказ генерируется на основе товаров, переданных в теле запроса.

Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.

Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Внимание

Параметр user.country.value используется для выбора валюты для заказа. Если страна пользователя неизвестна, альтернативным вариантом является указание IP-адреса пользователя в X-User-Ip заголовке.
Для корректной работы метода требуется один из этих двух вариантов.
Выбранная валюта используется для оплаты в Pay Station.
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
Телоapplication/json
custom_parametersobject or null(Cart-Payment_custom_parameters)[ 1 .. 200 ] properties

Ваши пользовательские параметры представлены в виде допустимого набора пар ключ-значение в формате JSON.
Вы можете передать дополнительные параметры через это поле для настройки фильтров защиты от мошенничества. Смотрите документацию Pay Station.

Пример: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
promo_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Уникальный код, чувствительный к регистру. Содержит буквы и цифры.

По умолчанию "WINTER2021"
Пример: "WINTER2021"
purchaseobject(Cart_admin_payment)обязательный
purchase.​itemsArray of objectsnon-emptyобязательный
purchase.​items[].​quantitynumber>= 1обязательный

Количество товара.

Пример: 2
purchase.​items[].​skustringnon-emptyобязательный

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

Пример: "t-shirt"
sandboxboolean(Cart-Payment_settings_sandbox)

Передайте значение true, чтобы провести тестовые платежи. Обратите внимание, что URL для страницы оплаты будет https://sandbox-secure.xsolla.com.

По умолчанию false
settingsobject

Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.

userobject(Cart-Payment_admin-user-request-body)обязательный
user.​ageinteger

Возраст пользователя.

user.​countryobject
user.​emailobject
user.​idobjectобязательный
user.​id.​valuestring[ 1 .. 255 ] characters

ID пользователя. При тестировании вы можете передать в параметре любые символы. Для приема реальных платежей передайте в параметре ID пользователя из вашей системы. Этот ID будет передаваться в вебхуке .

user.​is_legalboolean

Является ли пользователь юридическим лицом.

user.​legalobject

Объект с реквизитами юридического лица. Объект и все его параметры обязательны, если user.is_legal имеет значение true.

user.​nameobject
user.​phoneobject
user.​steam_idobject
user.​tracking_idobject
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/44056/admin/payment/token \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "items": [
        {
          "quantity": 2,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.t-shirt01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.hat01"
        }
      ]
    },
    "settings": {
      "currency": "USD",
      "external_id": "AABBCCDD01",
      "language": "de",
      "payment_method": 1380,
      "return_url": "https://developers.xsolla.com/ru/",
      "ui": {
        "theme": "63295aab2e47fab76f7708e3"
      }
    },
    "user": {
      "country": {
        "allow_modify": false,
        "value": "US"
      },
      "email": {
        "value": "user@xsolla.com"
      },
      "id": {
        "value": "user-id"
      },
      "name": {
        "value": "user-name"
      }
    }
  }'

Ответы

Платежный токен и заказ успешно созданны.

Телоapplication/json
order_idinteger

ID заказа.

Пример: 1
tokenstring

Платежный токен.

Ответ
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }
Операции
Операции
Операции
Операции
Операции

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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