アイテム配布 API

商品支給APIは、ウェブショップで商品を購入したユーザーの情報を照会します。

事前準備¶

商品支給APIを使用するには、以下のようなコンソールメニューから商品を支給する対象を選択します。
- コミュニティ & ウェブストア > ウェブストア > ウェブストア設定 > 商品支給
商品支給方法に応じて作成したAPIを登録します。

Note

商品の支給方法に応じたAPIの作成方法は、以下のリクエスト例で確認してください。

ゲームサーバーおよびチャンネル、キャラクターリストの照会¶

商品支給対象のゲームサーバーリストおよびサーバーに含まれるチャンネルとキャラクターリストを照会します。

リクエストURL¶

環境	URL
商用	https://{URL}/webstore-profile
サンドボックス	https://{URL}/webstore-profile
テスト	https://{URL}/webstore-profile

リクエストヘッダー¶

タイプ	値
Httpメソッド	POST
コンテンツタイプ	application/json

リクエストパラメータ¶

フィールド	タイプ	必須	説明
cs_code	文字列	O	ユーザー固有識別子

リクエストの例¶

{
  cs_code: "c_1234123"
}

応答データ¶

フィールド	タイプ	必須	説明
result_code	整数	O	結果コード
result_message	文字列	O	結果メッセージ
cs_code	文字列	O	ユーザー固有識別子
data	配列	O	サーバーリスト
data.server_id	文字列	O	サーバー固有識別子
data.server_name	文字列	O	サーバーの名前
data.channels	配列	O	サーバーに含まれるチャンネルリスト
data.channels.channel_id	文字列	O	チャンネル固有識別子（チャンネル未使用時の応答値: “0”）
data.channels.channel_name	文字列	O	チャンネルの名前（チャンネル未使用時の応答値: “-”）
data.channels.characters	配列	O	チャンネルに含まれるキャラクターリスト（キャラクター未使用時の応答値: []）
data.channels.characters.character_id	文字列	キャラクター使用時 O	キャラクター固有識別子
data.channels.characters.character_name	文字列	キャラクター使用時 O	キャラクターの名前
data.channels.characters.character_level	文字列	キャラクター使用時 O	キャラクターのレベル（キャラクターレベルがない場合の応答値: “-”）

レスポンスコード¶

コード	説明
200	成功
500	サーバーエラー
-	ユーザーに関する情報なし

応答の例¶

{
  "result_code": 200,
  "result_message": "success",
  "cs_code": "c_123412341234",
  "data": [
   {
    # Server, Channel, Character
    "server_id": "1",
    "server_name": "Server 1",
    "channels": [{
      "channel_id": "1",
      "channel_name": "Channel 1",
      "characters": [{
        "character_id": "A",
        "character_name": "Character A",
        "character_level": "99",
      },
      {
        "character_id": "B",
        "character_name": "Character B",
        "character_level": "10",
      }]
    }]
  },
  {
    # Server, Character
    "server_id": "2",
    "server_name": "Server 2",
    "channels": [{
      "channel_id": "0",
      "channel_name": "-",
      "characters": [{
        "character_id": "C",
        "character_name": "Character C",
        "character_level": "11",
      },
      {
        "character_id": "D",
        "character_name": "Character E",
        "character_level": "12",
      }]
    }]
  },
  {
    # Server, Channel
    "server_id": "3",
    "server_name": "Server 3",
    "channels": [{
      "channel_id": "2",
      "channel_name": "Channel 2",
      "characters": []
    }]
  },
  {
    # Server
    "server_id": "4",
    "server_name": "Server 4",
    "channels": [{
      "channel_id": "0",
      "channel_name": "-",
      "characters": []
    }]
  }
 ]} 
}