商品分发 API

商品发放API用于查询在网上商店购买商品的用户信息。

事前准备¶

要使用商品发放API，请在以下控制台菜单中选择要发放商品的对象。
- 社区 & 网店 > 网店 > 网店设置 > 商品发放
根据商品发放方式注册制作的API。

Note

有关根据商品发放方式制作API的方法，请参见下面的请求示例。

游戏服务器和频道、角色列表查询¶

查询商品发放对象的游戏服务器列表以及服务器中包含的频道和角色列表。

请求 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": []
    }]
  }
 ]} 
}