設定檔 API

個人資料 API 用於在控制台的社區中獨立運營「社區個人資料」或將「遊戲個人資料」與「社區個人資料」連接的情況。

預備工作¶

API 註冊¶

在控制台中點選社群個人資料，並根據要使用的個人資料類型註冊相應的 API。

只有使用社區個人資料時，基本個人資料圖片 API 註冊
連接遊戲個人資料時，遊戲個人資料 API 註冊

詳細內容請參考控制台的個人資料 API 整合。

允許防火牆規則¶

為使 Hive 伺服器能夠向應用程式伺服器 API 端點傳送請求，請在應用程式伺服器的防火牆設定中為以下 IP 位址新增入站（Inbound）允許規則。

Hive 伺服器 IP
15.165.223.210
3.34.158.195
43.202.20.33
13.209.91.38
3.34.235.15
15.165.134.120

基本個人資料圖片 API¶

基本的個人檔案圖片 API 僅在使用社群個人檔案類型中的社群個人檔案時，用於更改基本個人檔案圖片。

當請求基本個人資料圖片 API 時，Hive 伺服器會在 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

請求範例¶

{
    "pid" : "20000010000"
}

回應主體¶

資料類型: 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 參考：若以空值傳送，Web 商店中不會顯示個人資料區域，因此即使沒有合適的圖片，也建議傳送預設圖片。

回應代碼¶

代碼	消息	說明
100	成功.	成功
101	INVALID_REQUEST	缺少必要的鍵值
102	NOT_EXIST_USE	當用戶不存在時

回應範例¶

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