コンテンツへスキップ
/
コードをアップロード

Shop Builder API (2.0.0)

Overview

  • 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記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/shop-builder/
https://store.xsolla.com/api/

管理者

操作

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作

管理者

操作

カタログ

操作

カート（クライアント側）

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

このAPIは販売可能なアイテムや特定のアイテムを取得することができます。

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

コード読み込みセッションに関する情報を取得Server-sideAdmin

リクエスト

コード読み込みセッションに関する情報を取得します。

セキュリティ
basicAuth
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
session_idstring必須

セッションID。

デフォルト "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

レスポンス

セッション情報を読み込むコードが正常に受信されました。

ボディapplication/json
count_skippedinteger
例: 10
count_totalinteger
例: 100
count_uploadedinteger
例: 0
session_idstring
例: "fc7105b6e8ee01339582970b37697242"
statusstring
例: "processing"
レスポンス
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

コードをアップロードServer-sideAdmin

リクエスト

ゲームキーSKUによるコードをアップロードします。

セキュリティ
basicAuth
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディmultipart/form-data必須
filestring(binary)必須

コードを含むファイル。

例: "keys.txt"
region_idinteger

リージョンID。

例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/key/upload/sku/booster_mega_1 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

レスポンス

セッション情報を読み込むコードが正常に受信されました。

ボディapplication/json
count_skippedinteger
例: 10
count_totalinteger
例: 100
count_uploadedinteger
例: 0
session_idstring
例: "fc7105b6e8ee01339582970b37697242"
statusstring
例: "processing"
レスポンス
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

ゲームをSKUで削除Server-sideAdmin

リクエスト

SKUによるプロジェクト内のゲームを削除します。

セキュリティ
basicAuth
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/sku/booster_mega_1

レスポンス

ゲームは正常に削除されました。

レスポンス
コンテンツなし

通常

操作

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作