コンテンツへスキップ

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は販売可能なアイテムや特定のアイテムを取得することができます。

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

現在のユーザーのデイリー報酬を取得するClient-side

リクエスト

クライアントエンドポイント。現在のユーザーのデイリー報酬のリストを取得します。

注意

このメソッドはページ分割されたアイテムリストを返します。1 回のレスポンスで返されるアイテム数の上限とデフォルト値は50件です。それ以上のアイテムを取得する場合は、`limit`および `offset` パラメータを使用して追加のページを取得してください。例：`limit = 25`、`offset = 100`を指定した場合、全体リストの 101 件目から始まる 25 件が返されます。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号（カウントは0から始まります）。

例: offset=0
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/daily_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーのデイリー報酬が正常に取得されました。

ボディapplication/json
has_moreboolean

ページ数がもっとあることを示す指標として使用されます。

例: true
itemsArray of any(client-daily-chain-model)
total_items_countinteger

デイリー報酬の総数。

例: 3
レスポンス
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … },
    { … }
  ],
  "total_items_count": 3
}

ID を指定して現在のユーザーのデイリー報酬を取得します。Client-side

リクエスト

クライアントエンドポイント。ID を指定して現在のユーザーのデイリー報酬を取得します。

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

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

例: 44056
daily_chain_idinteger必須

デイリー報酬ID。

例: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/daily_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーのデイリー報酬が正常に取得されました。

ボディapplication/json
date_startstring(date-time)(calendar_hard_date_start)

デイリー報酬の開始日。

例: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

デイリー報酬が繰り返し発生するかどうか。trueの場合、デイリー報酬は終了日後に自動的にリセットされます。次回のstart_dateおよびend_dateのスケジュールは、デイリー報酬ステップの数とstart_dateに設定された初期時間に基づいて決定されます。

デフォルト false
例: true
typestring

ユーザーが報酬をいつ受け取れるかを決定するデイリー報酬のタイプ。

列挙型 値説明
calendar_hard

24時間ごとに次の報酬ステップが解除されます。次のステップ報酬が利用可能になると、受け取られなかった報酬は永久に失われます。

rolling_skippable

date_startに基づき、24時間ごとに次のステップの報酬を解除します。進行は順序通りです。前の報酬が受け取られるまでは、新しい報酬は解除されません。ユーザーが1日以上スキップした場合でも、中断したところから再開します。ミスした日に対して複数の報酬が付与されることはありません。

rolling_unskippable

date_startに基づき、24時間ごとに次のステップの報酬を解除します。進行は順序通りです。前の報酬が受け取られるまでは、新しい報酬は解除されません。ただし、ユーザーが1日でもスキップした場合、進行状況はリセットされ、最初のステップからやり直す必要があります。

ディスクリミネーター
date_endstring or null(date-time)(daily_chain_date_end)

デイリー報酬の終了日。nullにすることも可能です。calendar_hardタイプを設定すると、追加したステップ数に基づいてこの日付が自動的に設定されるため、nullのままにしておいても問題ありません。

例: "2020-04-15T18:16:00+05:00"
descriptionstring or null

デイリー報酬説明。

例: "Major weekly quest"
idinteger

デイリー報酬ID。

例: 9
namestring

デイリー報酬名。

例: "Weekly quest"
orderinteger(order)

配列順序を定義します。

例: 1
stepsArray of objects(client-daily-chain-step-model)
レスポンス
application/json
{
  "date_end": "2025-04-03T18:16:00+05:00",
  "date_start": "2025-04-01T18:16:00+05:00",
  "description": "Active daily reward description",
  "id": 101,
  "name": "Active daily reward",
  "order": 1,
  "steps": [
    { … },
    { … },
    { … },
    { … }
  ],
  "type": "calendar_hard"
}

デイリー報酬ステップを受け取るClient-side

リクエスト

クライアントエンドポイント。現在のユーザーがデイリー報酬からステップ報酬を受け取ります。すべてのステップは順番通りにしか受け取ることができません。取り逃したステップの報酬は、仮想通貨や実際通貨、または広告を視聴することで得ることはできません

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

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

例: 44056
daily_chain_idinteger必須

デイリー報酬ID。

例: 101
step_numberinteger必須

デイリー報酬ステップ番号。

例: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/daily_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

現在のユーザーのデイリー報酬ステップの報酬を正常に受け取りました。

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

管理者

操作

クライアント

操作

管理者

操作