# 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

デフォルトでは、エクソラログインユーザートークン（Bearerトークン）が認証に使用されます。テスト用のエクソラログインユーザートークンでこのエンドポイントを呼
び出すことができます：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。

[決済ステーションアクセストークン](https://developers.xsolla.com/ja/api/pay-station/operation/create-token/)を代用として使用することができます。

Type: http
Scheme: bearer
Bearer Format: JWT

### basicAuth

エクソラAPIはベーシックアクセス認証を使用します。APIへのすべてのリクエストは`Authorization: Basic 
<your_authorization_basic_key>`ヘッダーを含む必要があり、`your_authorization_basic_key`はBase6
4標準に従ってエンコードされた`project_id:api_key`ペアです。

必要に応じて、`project_id`の代わりに`merchant_id`を使用することができます。機能には影響しません。

[パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します：

* `merchant_id`が表示されます：
  * **会社設定 > 会社**セクションで
  * 任意のパブリッシャー・アカウント・ページのブラウザ・アドレス・バーにあるURL。URLは以下の形式です：`https://publisher.xsolla.co
    m/<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/ja/api/getting-started/#api_keys_overview)を参照してください。


Type: http
Scheme: basic

## Download OpenAPI description

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

## クライアント

### アイテムを消費する

 - [POST /v2/project/{project_id}/user/inventory/item/consume](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-client/consume-item.md): クライアントエンドポイント。現在のユーザーインベントリからアイテムを消費します。

### 現在のユーザーインベントリーを取得する

 - [GET /v2/project/{project_id}/user/inventory/items](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-client/get-user-inventory.md): クライアントエンドポイント。現在のユーザーインベントリを取得します。

注意すべてのプロジェクトには、回答で得られるアイテムの数に制限があります。初期値および最大値は、1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、LIMITとOFFSETフィールドを使用してください。

### 現在のユーザーの時間制限のあるアイテムを取得する

 - [GET /v2/project/{project_id}/user/time_limited_items](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-client/get-user-subscriptions.md): クライアントエンドポイント。現在のユーザーの時間制限のあるイテムを取得します。

### 現在のユーザーの仮想残高を取得

 - [GET /v2/project/{project_id}/user/virtual_currency_balance](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-client/get-user-virtual-balance.md): クライアントエンドポイント。現在のユーザーの仮想残高を取得します。

## 管理

### 購入したアイテムをユーザーに付与する

 - [POST /v2/project/{project_id}/inventory/purchase](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-management/grant-item-by-purchase.md): 指定されたユーザーインベントリに、指定された購入アイテムを追加します。

注意一度に処理できる操作は最大50個です。この制限を超える操作は無視されます。

### インベントリアイテムを取り消す

 - [POST /v2/project/{project_id}/inventory/revoke](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-management/revoke-item.md): 複数のユーザーのアイテムのアクセス権を剥奪します。

注意一度に処理できる操作は最大50個です。この制限を超える操作は無視されます。

### アイテムをユーザーに付与する

 - [POST /v2/project/{project_id}/inventory/reward](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-management/add-item-to-inventory.md): 指定されたユーザーインベントリに、指定されたアイテムを追加します。

注意一度に処理できる操作は最大50個です。この制限を超える操作は無視されます。

### ユーザーにアイテムを設定する

 - [POST /v2/project/{project_id}/inventory/set](https://developers.xsolla.com/ja/api/deprecated/inventory/inventory-management/set-item-quantity.md): 指定されたユーザーインベントリに指定された項目を設定します。ただし、新しいデータは古いデータに置き換わります。

注意一度に処理できる操作は最大50個です。この制限を超える操作は無視されます。

## クロスインベントリ

### ゲームアカウントとエクソラを接続

 - [POST /v2/project/{project_id}/inventory/account/link](https://developers.xsolla.com/ja/api/deprecated/inventory/cross-inventory/inventory-account-link.md): ユーザーのゲームアカウントとエクソラアカウントを接続します。

### ユーザートークン化

 - [POST /v2/project/{project_id}/inventory/account/signin](https://developers.xsolla.com/ja/api/deprecated/inventory/cross-inventory/inventory-account-signin.md): パブリッシングプラットフォームのユーザーに対して、Shop Builder APIと連携するためのJWTを取得します。