# Shop Builder API

# Overview

* **Version:** 2.0.0
* **Servers**: `https://store.xsolla.com/api`
* **[Contact Us by Email](mailto:integration@xsolla.com)**
* **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.

Version: 2.0.0

## Servers

```
https://store.xsolla.com/api
```

## Security

### XsollaLoginUserJWT

默认情况下使用艾克索拉登录管理器用户JWT（持有者令牌）进行授权。您可以尝试使用艾克索拉登录管理器测试用户JWT令牌来调用此端点：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。

您也可以用[支付中心访问令牌](https://developers.xsolla.com/zh/api/pay-station/operation/create-token/)作为替代。

Type: http
Scheme: bearer
Bearer Format: JWT

### basicAuth

Xsolla API 使用基本访问身份验证。所有对 API 的请求都必须包含`Authorization: Basic 
<your_authorization_basic_key>`标题，其中`your_authorization_basic_key`是个`project_id:
api_key`根据 Base64 标准进行编码。

您可以使用`merchant_id` 而不是`project_id` 如果需要的话。它不会影响功能。

去[发布商帐户](https://publisher.xsolla.com/)查找参数值：

* `merchant_id` 显示为：
  * 在 **公司设置 > 公司** 部分
  * 在任何发布商帐户页面的浏览器地址栏中的 URL 中。URL 
    的格式如下：`https://publisher.xsolla.com/<merchant_id>`。
* `api_key` 创建后仅在发布商帐户中显示一次，并且必须存储在您这边。您可以在以下部分创建新密钥：
  * **公司设置 > API 密钥**
  * **项目设置 > API 密钥**
* `project_id` 显示为：
  * 在发布者帐户中，项目名称旁边。
  * 在发布者帐户中处理项目时，浏览器地址栏中的 URL。URL 
    格式如下：`https://publisher.xsolla.com/<merchant_id>/projects/<project_id>`。

有关使用 API 密钥的更多信息，请参阅[API 参考](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview)。


Type: http
Scheme: basic

## Download OpenAPI description

[Shop Builder API](https://developers.xsolla.com/_bundle/@l10n/zh/api/deprecated/inventory/index.yaml)

## 客户端

### 消耗商品

 - [POST /v2/project/{project_id}/user/inventory/item/consume](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-client/consume-item.md): 客户端端点。从当前用户物品库中消耗一个商品。

### 获取当前用户物品库

 - [GET /v2/project/{project_id}/user/inventory/items](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-client/get-user-inventory.md): 客户端端点。检索当前用户物品库。

注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。

### 获取当前用户的时效性商品

 - [GET /v2/project/{project_id}/user/time_limited_items](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-client/get-user-subscriptions.md): 客户端端点。检索当前用户的时效性商品。

### 获取当前用户的虚拟余额

 - [GET /v2/project/{project_id}/user/virtual_currency_balance](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-client/get-user-virtual-balance.md): 客户端端点。检索当前用户的虚拟余额。

## 管理

### 按购买项向用户发放商品

 - [POST /v2/project/{project_id}/inventory/purchase](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-management/grant-item-by-purchase.md): 按购买项将指定商品添加到指定的用户物品库中。

注意： 一次只能处理50个操作。超出此限制的操作将被忽略。

### 撤回物品库商品

 - [POST /v2/project/{project_id}/inventory/revoke](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-management/revoke-item.md): 撤销对多个用户的商品访问权限。

注意： 一次只能处理50个操作。超出此限制的操作将被忽略。

### 向用户发放商品

 - [POST /v2/project/{project_id}/inventory/reward](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-management/add-item-to-inventory.md): 将指定商品添加到指定的用户物品库中。

注意： 一次只能处理50个操作。超出此限制的操作将被忽略。

### 将商品设置给用户

 - [POST /v2/project/{project_id}/inventory/set](https://developers.xsolla.com/zh/api/deprecated/inventory/inventory-management/set-item-quantity.md): 将指定商品设置到指定物品库。注意，新数据将替换旧数据。

注意： 一次只能处理50个操作。超出此限制的操作将被忽略。

## 跨平台物品库

### 将游戏帐户连接到艾克索拉

 - [POST /v2/project/{project_id}/inventory/account/link](https://developers.xsolla.com/zh/api/deprecated/inventory/cross-inventory/inventory-account-link.md): 将用户游戏帐户与艾克索拉帐户关联起来。

### 用户令牌化

 - [POST /v2/project/{project_id}/inventory/account/signin](https://developers.xsolla.com/zh/api/deprecated/inventory/cross-inventory/inventory-account-signin.md): 获取JWT，以便为您发布平台的用户操作Shop Builder API。