Catalog API (2.0.0)
- 版本: 2.0.0
- 服务器:
https://store.xsolla.com/api - 通过邮件联系我们
- 联系URL: https://xsolla.com/
- 必需的TLS版本: 1.2
商品目录API支持在艾克索拉侧配置游戏内商品目录,并在您的商店中向用户展示目录内容。
通过该API可管理以下目录实体:
- 虚拟物品 — 游戏内物品,例如武器、皮肤、增益道具。
- 虚拟货币 — 用于购买虚拟商品的虚拟货币。
- 虚拟货币套餐 — 预定义的虚拟货币捆绑包。
- 捆绑包 — 虚拟物品、货币或游戏激活码的组合套餐,以单个SKU形式出售。
- 游戏密钥 — 适用于Steam等平台或其他DRM提供商分发的游戏和DLC激活码。
- 组 — 用于在目录中组织和排序商品的逻辑分组。
API分为以下组别:
Admin — 用于创建、更新、删除和配置目录商品及分组的调用。通过基本认证方式验证身份,需使用您的商户或项目凭据。不适用于商店前端调用。Catalog — 用于检索商品并构建面向最终用户的自定义商店前端。专为高负载场景设计。支持可选的用户JWT授权,可返回个性化数据,例如用户特定限制和当前进行中的促销活动。
下载 OpenAPI 描述
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
- https://connector.xsolla.com/v1/admin/projects/{project_id}/connectors/import_items/import/status
- Mock serverhttps://xsolla.redocly.app/_mock/zh/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 时区)。如果导入因错误而中断且未导入任何项,则将返回空字符串。
示例: "2024-11-19T15:27:31+03:00"
包含特定商品SKU的导入结果和导入错误数据的对象。
示例: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
响应
application/json
{ "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" }
正文application/json
包含JSON格式数据的文件的URL。该文件应托管在具有公共访问权限的存储服务上。您可以在发布商帐户的商店 > 虚拟物品 > 目录管理 > 导入商品 (JSON)部分中下载文件模板。
示例: "https://my-bucket.s3.amazonaws.com/items.json"
- https://connector.xsolla.com/v1/projects/{project_id}/import/from_external_file
- Mock serverhttps://xsolla.redocly.app/_mock/zh/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"
}'响应
application/json
{ "import_id": "af9f3638a16e11ef880da2cd677d2d24" }