跳轉至

商品分發 API

商品發放 API 用於查詢在網上商店購買商品的用戶信息。

預備工作

  • 要使用商品發放 API,請在以下控制台菜單中選擇要發放商品的對象。
    • 社區 & 網路商店 > 網路商店 > 網路商店設定 > 商品發放
  • 根據商品發放方法註冊製作的 API。

Note

根據商品發放方式製作 API 的方法請參考下面的 Request Example

遊戲伺服器及頻道、角色列表查詢

查詢商品發放對象的遊戲伺服器列表及伺服器中包含的頻道和角色列表。

請求網址

環境 網址
商用 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": []
    }]
  }
 ]} 
}