Catalog API (2.0.0)
- Версия: 2.0.0
- Серверы:
https://store.xsolla.com/api - Свяжитесь с нами по электронной почте
- Адрес для связи: https://xsolla.com/
- Требуемая версия TLS: 1.2
API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.
API позволяет вам управлять такими сущностями каталога, как:
- Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
- Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
- Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
- Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
- Группы — логические группировки для организации и сортировки товаров в каталоге.
Методы API делятся на следующие группы:
Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://connector.xsolla.com/v1/admin/projects/{project_id}/connectors/import_items/import/status
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v1/admin/projects/{project_id}/connectors/import_items/import/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://connector.xsolla.com/v1/admin/projects/44056/connectors/import_items/import/statusСтатус импорта успешно получен.
Дата и время завершения операции импорта. Если импорт был прерван из-за ошибки и не было импортировано ни одного товара, будет передана пустая строка.
Дата и время создания операции импорта по часовому поясу GMT+3.
Дата и время, когда импорт был прерван из-за возникшей ошибки по часовому поясу GMT+3.
Объект с данными о результатах импорта и ошибках импорта по конкретным товарам.
{ "date_completed": "2024-11-19T15:27:31+03:00", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "error": null, "error_code": null, "progress": 100, "result": { "errors_by_sku": [ … ], "errors_count": 2, "total_entities_count": 10 }, "status": "error" }
Запрос
Импортирует товары в магазин из JSON-файла по указанному URL-адресу. Подробная информация об импорте из JSON-файла приведена в документации.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Фиксированное значение, определяющее тип операции для импорта товаров.
URL-адрес файла с данными в формате JSON. Файл должен быть размещен на сервисе хранения данных в публичном доступе. Шаблон файла вы можете скачать в Личном кабинете в разделе Store > Виртуальные предметы > Управление каталогом > Импортировать товары (JSON).
- https://connector.xsolla.com/v1/projects/{project_id}/import/from_external_file
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v1/projects/{project_id}/import/from_external_file
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://connector.xsolla.com/v1/projects/44056/import/from_external_file \
-H 'Content-Type: application/json' \
-d '{
"connector_external_id": "import_items",
"file_url": "https://my-bucket.s3.amazonaws.com/items.json",
"mode": "create"
}'{ "import_id": "af9f3638a16e11ef880da2cd677d2d24" }