프로필 API

프로필 API는 Hive 콘솔 > 커뮤니티 & 웹 상점 > 커뮤니티 > 게임 데이터 연동 > 프로필 설정에서 프로필 유형으로 '커뮤니티 프로필' 또는 '게임 프로필'을 선택한 경우 사용합니다. Hive 서버가 앱으로 프로필 API를 요청하면, 앱에서 Hive 서버로 응답 값을 반환합니다.

사전 준비¶

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
정사각형 비율의 형태
모서리 코너 값 및 테두리 아웃라인은 기본 적용됨

Request URL¶

콘솔 환경	API 엔드포인트
상용	https://{URL}/profile/get-image-list
샌드박스	https://{URL}/profile/get-image-list

Request body¶

Method type: POST
Parameters
- 파라미터 없음

Response body¶

Data type: Json

Parameters

이름	설명	타입	value
result	결과 값	JSON Object
result.code	결과 코드	Integer	성공 시: 100
result.msg	결과 메시지	String
params	데이터	JSON Object
params.total	이미지 개수	Integer	params.list 항목 수
params.list	이미지 리스트(URL)	String Array	["https://test-img.co.kr/profile1.jpg", ...]

Response Code¶

HTTP 상태 코드	코드	메시지	설명
200	100	success	성공

성공 시 반드시 코드(result.code)를 100으로 전달하세요.

Response Sample¶

{
    "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는 아래와 같이 프로필 유형을 앱 프로필 연동으로 선택하는 경우 사용합니다.

앱 프로필과 연동된 프로필 정보는 커뮤니티에 로그인할 때 업데이트됩니다.

Request URL¶

콘솔 환경	API 엔드포인트
상용	https://{URL}/profile/get-player
샌드박스	https://{URL}/profile/get-player

Request body¶

Method type: POST
Parameters

필드명 설명 타입 필수 여부

pid 사용자의 Player ID string Y

Request sample¶

{
    "pid" : "20000010000"
}

Response body¶

Data type: Json

Parameters

이름	설명	Type	Value
result	결과 값	JSON Object
result.code	결과 코드	Integer	성공 시: 100
result.msg	결과 메시지	String
params	데이터	JSON Object
params.pid	사용자의 Player ID	String	20000010000
params.nickname	사용자의 닉네임	String	홍길동
params.p_image	사용자의 프로필 이미지 URL	String	https://test-img.co.kr/profile1.jpg 참고: 빈 값으로 전달 시 웹 상점에 프로필 영역이 노출되지 않으므로, 적절한 이미지가 없더라도 디폴트 이미지로 전달을 권장합니다.

Response code¶

HTTP 상태 코드	코드	메시지	설명
200	100	success	성공
	101	INVALID_REQUEST	필요한 키 값 누락
	102	NOT_EXIST_USE	사용자가 존재하지 않을 때

Response sample¶

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