Hive 커뮤니티와 게임 정보 연동을 원하시면 아래의 프로토콜에 맞게 API를 개발해야 합니다.
API URL을 등록하실 때, 반드시 https://를 포함해서 등록해 주세요.
유저 계정 프로필
유저 계정 프로필은 콘솔에 API URL을 등록하면, 정보가 바로 업데이트 됩니다.
유저 계정 프로필 API를 연동하지 않으면, 커뮤니티와 게임 계정은 별개로 운영됩니다.
- Request URL
상용 URL | https://${URL}/profile/get-player |
테스트 URL | https://${URL}/profile/get-player |
- Request Body
- type : post
- Parameters
필드명 | 설명 | 타입 | 필수여부 |
pid | 유저의 PlayerID | string | Y |
- Sample
1 2 3 |
{ "pid" : "20000010000" } |
- Response Body
- type : json
- Parameters
이름 | 설명 | Type | value값 |
result | 결과값 | JSON Obejct | |
result.code | 결과코드
(100:성공) |
Integer | 100 |
result.msg | 결과 메시지 | String | |
params | 파라미터 | JSON Obejct | |
params.pid | 유저의 PlayerID | String | 20000010000 |
params.nickname | 유저의 닉네임 | String | 홍길동 |
params.p_image | 유저의 프로필 이미지 URL | String | https://test-img.co.kr/profile1.jpg |
- 리턴코드
- 100 – SUCCESS – 성공(성공은 반드시 100으로 전달 주시기 바랍니다.)
- 101 – INVALID_REQUEST – 필요한 키값이 누락되었을 때
- 102 – NOT_EXIST_USER – 유저가 존재하지 않을 때
- Response Sample
1 2 3 4 5 6 7 8 9 10 11 |
{ "result": { "code": 100, "msg": "success" }, "params": { "pid": "20000010000", "nickname": "홍길동", "p_image": "https://test-img.co.kr/profile1.jpg" } } |
프로필 이미지
커뮤니티 기본 프로필 이미지를 변경할 때 사용합니다.
프로필 이미지 API는 02:00 (KST)에 배치 프로그램으로 API 조회 후, 정보 업데이트가 됩니다. (상용, 샌드박스 공통)
- Request URL
상용 URL | https://${URL}/profile/get-image-list |
테스트 URL | https://${URL}/profile/get-image-list |
- Request BODY
- type : post
- Parameters
- 파라미터 없음
- Response BODY
- type : json
- Parameters
이름 | 설명 | TYPE | value값 |
result | 결과값 | JSON Object | |
result.code | 결과 코드
(100 : 성공) |
Integer | 100 |
result.msg | 결과 메시지 | String | |
params | 파라미터 | JSON Object | |
params.total | 리스트 갯수 | int | 10 |
params.list | 리스트(이미지 URL) | String Away | \[“https://test-img.co.kr/profile1.jpg“,”https://test-img.co.kr/profile2.jpg” … \] |
- 리턴코드
- 100 – SUCCESS – 성공(성공은 반드시 100으로 전달 주시기 바랍니다.)
- Response Sample
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "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" ] } } |