配置文件 API
个人资料 API 用于在控制台的社区中独立运行“社区个人资料”或将“游戏个人资料”与“社区个人资料”关联的情况。
预备工作¶
在控制台中点击社区个人资料,根据您要使用的个人资料类型注册相关的API。
- 仅使用社区个人资料时,基本个人资料图片 API 注册
- 连接游戏个人资料时,游戏个人资料 API 注册
有关详细信息,请参阅控制台的 个人资料 API 集成。
基本个人资料图片 API¶
基本个人资料图片API在仅使用社区个人资料类型的情况下,如下所示,用于更改基本个人资料图片。
请求基本个人资料图片 API 时,服务器将在 02:00 (KST) 通过批处理程序查询标题 API,然后更新个人资料信息。(生产环境,沙盒共用)
个人资料图片尺寸规定如下。
- 最小 160 x 160px
- 正方形比例的形状
- 角落圆角值和边框轮廓默认应用
请求 URL¶
商用 URL | https://{URL}/profile/get-image-list |
---|---|
测试 URL | 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" ...]
响应代码¶
HTTP 状态码 | 代码 | 消息 | 说明 |
---|---|---|---|
200 | 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¶
商用 URL | https://${URL}/profile/get-player |
---|---|
测试 URL | https://${URL}/profile/get-player |
请求体¶
- 方法类型:POST
-
参数
字段名 说明 类型 是否必填 pid 用户的 PlayerID string Y
请求示例¶
响应体¶
- 数据类型: Json
-
参数
名称 描述 类型 值 result 结果值 JSON 对象 result.code 结果代码 (100:成功) 整数 100 result.msg 结果消息 字符串 params 参数 JSON 对象 params.pid 用户的 PlayerID 字符串 20000010000 params.nickname 用户的昵称 字符串 洪吉童 params.p_image 用户的个人资料图片 URL 字符串 https://test-img.co.kr/profile1.jpg
响应代码¶
HTTP 状态码 | 代码 | 消息 | 说明 |
---|---|---|---|
100 | 成功. | 成功 | |
101 | 无效请求 | 缺少必要的键值 | |
102 | 用户不存在 | 当用户不存在时 |