콘텐츠로 이동

프로필 API 연동

프로필 API 연동 메뉴에서 커뮤니티 프로필 유형에 따라 API를 설정해 주세요.

커뮤니티 프로필만 사용 시, 기본 프로필 이미지 API 등록
게임 프로필 연동 시, 게임 프로필 API 등록

기본 프로필 이미지 API¶

커뮤니티 기본 프로필 이미지를 변경할 때 사용합니다.

프로필 이미지 API는 02:00 (KST)에 배치 프로그램으로 API 조회 후, 정보 업데이트가 됩니다. (상용, 샌드박스 공통)
사이즈는 최소 160 x 160px이며, 모서리 코너 값 및 테두리 아웃라인은 기본 적용되는 사항이므로 정사각형 비율의 형태로 이미지를 제작해주세요.

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" ... \]

Return Code¶

+ 100 \- SUCCESS \- 성공(성공은 반드시 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¶

상용 URL	https://${URL}/profile/get-player
테스트 URL	https://${URL}/profile/get-player

Request Body¶

+ type : post
+ Parameters

필드명	설명	타입	필수여부
pid	유저의 PlayerID	string	Y

Sample¶

{
    "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

Return Code¶

+ 100 - SUCCESS - 성공(성공은 반드시 100으로 전달 주시기 바랍니다.)
+ 101 - INVALID_REQUEST - 필요한 키값이 누락되었을 때
+ 102 - NOT_EXIST_USER - 유저가 존재하지 않을 때

Response Sample¶

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