設定檔 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 字串 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 | INVALID_REQUEST | 缺少必要的鍵值 | |
102 | NOT_EXIST_USE | 當用戶不存在時 |