Spanish (Spain)
/
Получение ежедневной нагр...
Shop Builder API (2.0.0)
- 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 Платежей Иксолла.
Операции
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain/id/101Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain/id/101Данные о ежедневной награде успешно получены.
Дата, когда начнет действовать ежедневная награда.
Пример: "2020-04-15T18:16:00+05:00"
Перезапускается ли ежедневная награда. Если передано значение true, ежедневная награда автоматически сбрасывается в конце периода ее действия. Следующие значения для параметров start_date и end_date рассчитываются исходя из количества уровней ежедневной награды и времени старта ежедневной награды, заданном в параметре start_date.
По умолчанию false
Пример: true
Тип ежедневной награды, который определяет, когда пользователи могут получать награды.
| Перечисление Значение | Описание |
|---|---|
| calendar_hard | Разблокирует следующий уровень наград каждые 24 часа. Неполученные награды становятся недоступны, как только открывается награда за следующий уровень. |
| rolling_skippable | Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил один или несколько дней, Если пользователь пропускает один или несколько дней, он продолжает с того уровня, где остановился; за пропущенные дни награды не полагаются. |
| rolling_unskippable | Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил день, его прогресс сбрасывается и он начинает заново с первого уровня. |
Дискриминатор
Дата окончания срока действия ежедневных наград. Может быть null. При установке типа calendar_hard эта дата будет автоматически рассчитана по количеству добавленных уровней, поэтому можно оставить значение null.
Пример: "2020-04-15T18:16:00+05:00"
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Количество уровней, заданных в ежедневной награде. Каждый уровень означает один день в ежедневной награде.
Пример: 3
Ответ
application/json
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Daily reward short description" }, "id": 3, "is_enabled": true, "is_recurrent": false, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "number_of_steps": 3, "order": 1, "steps": [ { … }, { … }, { … } ], "type": "calendar_hard" }
Путь
Телоapplication/jsonID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
One of:
Ежедневная награда с типом calendar_hard.
Дата, когда начнет действовать ежедневная награда.
Пример: "2020-04-15T18:16:00+05:00"
Перезапускается ли ежедневная награда. Если передано значение true, ежедневная награда автоматически сбрасывается в конце периода ее действия. Следующие значения для параметров start_date и end_date рассчитываются исходя из количества уровней ежедневной награды и времени старта ежедневной награды, заданном в параметре start_date.
По умолчанию false
Пример: true
Тип ежедневной награды, который определяет, когда пользователи могут получать награды.
| Перечисление Значение | Описание |
|---|---|
| calendar_hard | Разблокирует следующий уровень наград каждые 24 часа. Неполученные награды становятся недоступны, как только открывается награда за следующий уровень. |
| rolling_skippable | Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил один или несколько дней, Если пользователь пропускает один или несколько дней, он продолжает с того уровня, где остановился; за пропущенные дни награды не полагаются. |
| rolling_unskippable | Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил день, его прогресс сбрасывается и он начинает заново с первого уровня. |
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)обязательный
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Количество уровней ежедневной награды для этого артикула
Уникальный ID уровня цепочки наград. Укажите его при обновлении, чтобы сохранить прогресс пользователя для этого уровня.
Пример: 10
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
-H 'Content-Type: application/json' \
-d '{
"date_start": "2023-04-15T18:16:00+05:00",
"description": {
"en": "Updated daily reward description"
},
"is_enabled": true,
"name": {
"en": "Updated daily reward",
"ru": "Обновленная ежедневная награда"
},
"order": 4,
"steps": [
{
"items": [
{
"quantity": 1,
"sku": "vg_enabled_shown_in_store_1"
}
],
"step_number": 1
},
{
"items": [
{
"quantity": 1,
"sku": "vg_enabled_shown_in_store_2"
}
],
"step_number": 2
},
{
"items": [
{
"quantity": 1,
"sku": "vg_not_shown_in_store"
}
],
"step_id": 10,
"step_number": 3
},
{
"items": [
{
"quantity": 1,
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
}
],
"step_id": 8,
"step_number": 4
},
{
"items": [
{
"quantity": 1,
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
}
],
"step_number": 5
}
],
"type": "calendar_hard"
}'