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

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
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/digital-distribution-hub/
https://store.xsolla.com/api/

Корзина

Операции

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

Операции

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

Операции

Бандлы

Операции

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

Запрос

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

Обратите внимание. Все проекты имеют ограничение на количество предметов, которые вы можете получить в ответе. По умолчанию (максимальное значение) — 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://xsolla.redocly.app/_mock/ru/api/digital-distribution-hub/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)
Ответ
application/json
{
  "items": [
    { … }
  ]
}

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

Запрос

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

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

ID проекта.

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

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

Пример: kg_1
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ru/api/digital-distribution-hub/v2/project/44056/items/bundle/sku/kg_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

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

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

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

По умолчанию []
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"}]
descriptionstring or null(Catalog_client_description)

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

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

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

По умолчанию []
Пример: [{"external_id":"horror","name":{"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)

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

skustring(Catalog_sku)

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

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

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

typestring(Catalog_type)

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

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

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

Ответ
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": []
}

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

Операции

Уведомления

Операции

Заказ

Операции