跳转至

配置文件 API 同步

请根据社区档案类型在档案API集成菜单中设置API。

  • 仅使用社区资料时,注册 基本资料图片 API
  • 链接游戏资料时,注册 游戏资料 API


默认个人资料图片

个人资料图片 API 用于更改默认社区个人资料图片。

  • API 通过 批处理程序在 02:00 (KST) 进行信息检索和更新(适用于生产和沙盒环境)。
  • 尺寸必须至少为 160 x 160 像素,默认情况下应用圆角和边框轮廓,因此请创建正方形比例的图像。

请求 URL

商业网址 https://${URL}/profile/get-image-list
测试网址 https://${URL}/profile/get-image-list

请求主体

+ 类型 : post
+ 参数
    - 无参数

响应主体

+ 类型 : json
+ 参数
名称 描述 类型
result 结果 JSON 对象
result.code 结果代码 (100 : 成功) 整数 100
result.msg 结果消息 字符串
params 参数 JSON 对象
params.total 列表数量 int 10
params.list 列表(图片 URL) 字符串数组 \["https://test-img.co.kr/profile1.jpg","https://test-img.co.kr/profile2.jpg" ... \]

返回代码

+ 100 \- 成功 \- 成功(请确保成功始终用 100 表示。)

响应示例

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params":{
        "total": 10,
        "list":[
                "https://test-img.co.kr/profile1.jpg",
                "https://test-img.co.kr/profile2.jpg",
                "https://test-img.co.kr/profile3.jpg",
                ……
                "https://test-img.co.kr/profile10.jpg"
        ]
    }
}


游戏档案 API

管理员可以配置API,以便用户在社区和游戏中拥有相同的个人资料。

  • 当用户登录社区时,游戏资料会被更新。

请求 URL

商业网址 https://${URL}/profile/get-player
测试网址 https://${URL}/profile/get-player

请求体

+ 类型 : post
+ 参数
字段名称 描述 类型 必需
pid 用户的 PlayerID 字符串

示例

{
    "pid" : "20000010000"
}

响应体

+ 类型 : json
+ 参数
名称 描述 类型
result 结果 JSON 对象
result.code 结果代码 (100: 成功) 整数 100
result.msg 结果消息 字符串
params 参数 JSON 对象
params.pid 用户的 PlayerID 字符串 20000010000
params.nickname 用户的昵称 字符串 Tom
params.p_image 用户的头像图片 URL 字符串 https://test-img.co.kr/profile1.jpg

返回代码

+ 100 - 成功 - 成功(请确保成功始终用100表示。)
+ 101 - 无效请求 - 当必需的键值缺失时
+ 102 - 用户不存在 - 当用户不存在时

响应示例

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params": {
        "pid": "20000010000",
        "nickname": "Tom",
        "p_image": "https://test-img.co.kr/profile1.jpg"
    }
}