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

Digital Distribution Hub (1.0.0)

Введение

Digital Distribution Hub — новое решение Иксоллы, которое соединяет электронные и физические платежи через технологию push-платежей и e-commerce.

Данная документация включает в себя описание методов API для продуктов Внутриигровой магазин и Платежи. Используется два базовых URL-адреса:

  • https://store.xsolla.com/api для групп Общие, Каталог, Корзина и Заказ.
  • https://ps.xsolla.com для группы Уведомления.

Использование методов API из группы Каталог не требует авторизации.

Чтобы использовать методы API из групп Корзина и Заказ, вам необходимо создать токен.

Примечание

Данная документация не является полностью функциональным интерфейсом и представляет собой дизайн будущего API. В настоящее время вы можете использовать только методы из групп Каталог и Уведомления. Если вы хотите поделиться обратной связью, отправьте нам письмо по адресу techdoc@xsolla.com.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/digital-distribution-hub/

Корзина

Операции

Игровые ключи

Операции

Виртуальные предметы и валюта

Операции

Бандлы

Операции

Получение списка бандлов

Запрос

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

Обратите внимание. Все проекты имеют ограничение на количество предметов, которые вы можете получить в ответе. По умолчанию (максимальное значение) — 50 предметов в одном ответе.
Безопасность
AuthForClient
Путь
project_idintegerобязательный

ID проекта.

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

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

Пример: limit=50
offsetinteger

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

Пример: offset=0
localestring

Язык ответа. Используется двухбуквенное обозначение языка согласно стандарту ISO 639-1.

По умолчанию "en"
additional_fields[]Array of strings

Список дополнительных полей. Эти поля будут в ответе, если вы отправите их в запросе. Доступные поля: media_list, order, long_description.

countrystring

Страна для расчета региональных цен и ограничений для каталога. Используется двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Если вы не укажете страну, она будет рассчитана на основе IP-адреса пользователя.

По умолчанию "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Список бандлов успешно получен.

Телоapplication/json
itemsArray of objects(Catalog_client_bundle)
items[].​attributesArray of objects(Catalog_client-attributes-common)

Список атрибутов и их значений, соответствующих предмету. Может использоваться для фильтрации каталога.

По умолчанию []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

Пример: "attribute_1"
items[].​attributes[].​namestring

Название атрибута.

Пример: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

Пример: "attribute_value"
items[].​attributes[].​values[].​valuestring

Значение атрибута.

Пример: "Strategy"
items[].​bundle_typestring(Catalog_bundle_type)

Тип бандла. Всегда принимает значение standart.

Пример: "standart"
items[].​contentArray of objects(Catalog_client_content)

Содержимое пакета бандлов.

Пример: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
items[].​content[].​descriptionstring

Описание предмета.

Пример: "Big Rocket - description"
items[].​content[].​image_urlstring

URL изображения.

Пример: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​content[].​namestring

Наименование предмета.

Пример: "Big Rocket"
items[].​content[].​priceobject or null

Стоимость предмета.

items[].​content[].​price.​amountstring

Цена предмета со скидкой.

Пример: "100.99"
items[].​content[].​price.​amount_without_discountstring

Стоимость предмета.

Пример: "100.99"
items[].​content[].​price.​currencystring

Валюта покупки по умолчанию. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
items[].​content[].​quantityinteger

Количество предметов в пакете.

Пример: 250
items[].​content[].​skustring

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

Пример: "big_rocket"
items[].​content[].​typestring

Тип предмета: virtual_good/virtual_currency/bundle.

Пример: "virtual_currency"
items[].​content[].​virtual_pricesArray of objects

Виртуальные цены.

items[].​content[].​virtual_prices[].​amountinteger

Стоимость предмета в виртуальной валюте со скидкой.

Пример: 100
items[].​content[].​virtual_prices[].​amount_without_discountinteger

Стоимость предмета.

Пример: 200
items[].​content[].​virtual_prices[].​descriptionstring

Описание виртуальной валюты.

Пример: "Big Rocket - description"
items[].​content[].​virtual_prices[].​image_urlstring

Изображение виртуальной валюты.

Пример: "http://image.png"
items[].​content[].​virtual_prices[].​is_defaultboolean

Является ли цена предмета ценой по умолчанию.

Пример: true
items[].​content[].​virtual_prices[].​namestring

Название виртуальной валюты.

Пример: "SHOTGUN FOR TRUE RAIDERS"
items[].​content[].​virtual_prices[].​skustring

Артикул виртуальной валюты.

Пример: "vc_test"
items[].​content[].​virtual_prices[].​typestring

Тип виртуальной валюты.

Пример: "virtual_currency"
items[].​descriptionstring or null(Catalog_client_description)

Описание предмета.

Пример: "Big Rocket - description."
items[].​groupsArray of objects(Catalog_groups_response)

Группы, к которым принадлежит предмет.

По умолчанию []
Пример: [{"external_id":"horror","name":{"en":"Horror"}}]
items[].​groups[].​external_idstring
Пример: "horror"
items[].​groups[].​nameobject
Пример: {"en":"Horror"}
items[].​image_urlstring or null(Catalog_image_url)

URL изображения.

Пример: "https://image.example.com"
items[].​is_freestring(Catalog_is_free)

Всегда false.

По умолчанию "false"
Пример: "false"
items[].​namestring(Catalog_client_name)

Наименование предмета.

Пример: "Big Rocket"
items[].​priceobject or null(Catalog_price)

Стоимость предмета.

items[].​price.​amountstring(Catalog_amount)^\d*\.?\d*$обязательный

Цена предмета со скидкой.

Пример: "100.99"
items[].​price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$обязательный

Стоимость предмета.

Пример: "100.99"
items[].​price.​currencystring(Catalog_currency)обязательный

Валюта покупки. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
items[].​skustring(Catalog_sku)

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

Пример: "bundle_1"
items[].​total_content_priceobject or null(Catalog_total_content_price)

Общая стоимость содержимого бандла.

items[].​total_content_price.​amountstring

Общая стоимость содержимого бандла со скидкой.

Пример: "100.99"
items[].​total_content_price.​amount_without_discountstring

Общая стоимость содержимого бандла.

Пример: "100.99"
items[].​total_content_price.​currencystring(Catalog_currency)

Валюта покупки. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
items[].​typestring(Catalog_type)

Тип предмета.

Пример: "bundle"
items[].​virtual_pricesArray of objects(Catalog_virtual_prices)

Виртуальные цены.

items[].​virtual_prices[].​amountinteger

Стоимость предмета в виртуальной валюте со скидкой.

Пример: 100
items[].​virtual_prices[].​amount_without_discountinteger

Цена предмета в виртуальной валюте.

Пример: 200
items[].​virtual_prices[].​descriptionstring or null

Описание виртуальной валюты.

Пример: "Most popular gold"
items[].​virtual_prices[].​image_urlstring or null

Изображение виртуальной валюты.

Пример: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

Является ли цена предмета ценой по умолчанию.

Пример: true
items[].​virtual_prices[].​namestring

Название виртуальной валюты.

Пример: "Gold"
items[].​virtual_prices[].​skustring

Артикул виртуальной валюты.

Пример: "gold"
items[].​virtual_prices[].​typestring

Тип виртуальной валюты.

Пример: "virtual_currency"
Ответ
application/json
{
  "items": [
    { … }
  ]
}

Получение указанного бандла

Запрос

Получение указанного бандла.

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

ID проекта.

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

Артикул бандла.

Пример: kg_1
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/items/bundle/sku/kg_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Указанный бандл успешно получен.

Телоapplication/json
attributesArray of objects(Catalog_client-attributes-common)

Список атрибутов и их значений, соответствующих предмету. Может использоваться для фильтрации каталога.

По умолчанию []
attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

Пример: "attribute_1"
attributes[].​namestring

Название атрибута.

Пример: "Genre"
attributes[].​valuesArray of objects
attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

Пример: "attribute_value"
attributes[].​values[].​valuestring

Значение атрибута.

Пример: "Strategy"
bundle_typestring(Catalog_bundle_type)

Тип бандла. Всегда принимает значение standart.

Пример: "standart"
contentArray of objects(Catalog_client_content)

Содержимое пакета бандлов.

Пример: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
content[].​descriptionstring

Описание предмета.

Пример: "Big Rocket - description"
content[].​image_urlstring

URL изображения.

Пример: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
content[].​namestring

Наименование предмета.

Пример: "Big Rocket"
content[].​priceobject or null

Стоимость предмета.

content[].​price.​amountstring

Цена предмета со скидкой.

Пример: "100.99"
content[].​price.​amount_without_discountstring

Стоимость предмета.

Пример: "100.99"
content[].​price.​currencystring

Валюта покупки по умолчанию. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
content[].​quantityinteger

Количество предметов в пакете.

Пример: 250
content[].​skustring

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

Пример: "big_rocket"
content[].​typestring

Тип предмета: virtual_good/virtual_currency/bundle.

Пример: "virtual_currency"
content[].​virtual_pricesArray of objects

Виртуальные цены.

content[].​virtual_prices[].​amountinteger

Стоимость предмета в виртуальной валюте со скидкой.

Пример: 100
content[].​virtual_prices[].​amount_without_discountinteger

Стоимость предмета.

Пример: 200
content[].​virtual_prices[].​descriptionstring

Описание виртуальной валюты.

Пример: "Big Rocket - description"
content[].​virtual_prices[].​image_urlstring

Изображение виртуальной валюты.

Пример: "http://image.png"
content[].​virtual_prices[].​is_defaultboolean

Является ли цена предмета ценой по умолчанию.

Пример: true
content[].​virtual_prices[].​namestring

Название виртуальной валюты.

Пример: "SHOTGUN FOR TRUE RAIDERS"
content[].​virtual_prices[].​skustring

Артикул виртуальной валюты.

Пример: "vc_test"
content[].​virtual_prices[].​typestring

Тип виртуальной валюты.

Пример: "virtual_currency"
descriptionstring or null(Catalog_client_description)

Описание предмета.

Пример: "Big Rocket - description."
groupsArray of objects(Catalog_groups_response)

Группы, к которым принадлежит предмет.

По умолчанию []
Пример: [{"external_id":"horror","name":{"en":"Horror"}}]
groups[].​external_idstring
Пример: "horror"
groups[].​nameobject
Пример: {"en":"Horror"}
image_urlstring or null(Catalog_image_url)

URL изображения.

Пример: "https://image.example.com"
is_freestring(Catalog_is_free)

Всегда false.

По умолчанию "false"
Пример: "false"
namestring(Catalog_client_name)

Наименование предмета.

Пример: "Big Rocket"
priceobject or null(Catalog_price)

Стоимость предмета.

price.​amountstring(Catalog_amount)^\d*\.?\d*$обязательный

Цена предмета со скидкой.

Пример: "100.99"
price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$обязательный

Стоимость предмета.

Пример: "100.99"
price.​currencystring(Catalog_currency)обязательный

Валюта покупки. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
skustring(Catalog_sku)

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

Пример: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

Общая стоимость содержимого бандла.

total_content_price.​amountstring

Общая стоимость содержимого бандла со скидкой.

Пример: "100.99"
total_content_price.​amount_without_discountstring

Общая стоимость содержимого бандла.

Пример: "100.99"
total_content_price.​currencystring(Catalog_currency)

Валюта покупки. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Пример: "USD"
typestring(Catalog_type)

Тип предмета.

Пример: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Виртуальные цены.

virtual_prices[].​amountinteger

Стоимость предмета в виртуальной валюте со скидкой.

Пример: 100
virtual_prices[].​amount_without_discountinteger

Цена предмета в виртуальной валюте.

Пример: 200
virtual_prices[].​descriptionstring or null

Описание виртуальной валюты.

Пример: "Most popular gold"
virtual_prices[].​image_urlstring or null

Изображение виртуальной валюты.

Пример: "http://image.png"
virtual_prices[].​is_defaultboolean

Является ли цена предмета ценой по умолчанию.

Пример: true
virtual_prices[].​namestring

Название виртуальной валюты.

Пример: "Gold"
virtual_prices[].​skustring

Артикул виртуальной валюты.

Пример: "gold"
virtual_prices[].​typestring

Тип виртуальной валюты.

Пример: "virtual_currency"
Ответ
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … }
  ],
  "description": "pricePoint_44056_1.",
  "groups": [],
  "is_free": false,
  "media_list": [],
  "name": "kg_10.00_bundle",
  "order": 999,
  "price": {
    "amount": 9.99,
    "amount_without_discount": 9.99,
    "currency": "USD"
  },
  "sku": "kg_1",
  "total_content_amount": {
    "amount": 10.99,
    "amount_without_discount": 10.99,
    "currency": "USD"
  },
  "type": "bundle",
  "virtual_prices": []
}

Токен пользователя

Операции

Уведомления

Операции

Заказ

Операции