프로필 API

프로필 API는 콘솔의 커뮤니티에서 '커뮤니티 프로필'만 독립적으로 운영하거나 '게임 프로필'을 '커뮤니티 프로필'과 연동하는 경우 사용합니다.

사전 준비¶

콘솔에서 커뮤니티 프로필을 클릭하여 사용하려는 프로필 유형에 따라 연동되는 API를 등록해야 합니다.

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

자세한 내용은 콘솔의 프로필 API 연동을 참고하세요.

기본 프로필 이미지 API¶

기본 프로필 이미지 API는 아래와 같이 커뮤니 프로필 유형에서 커뮤니티 프로필만 사용하는 경우, 기본 프로필 이미지를 변경할 때 사용합니다.

기본 프로필 이미지 API 요청하면, 서버에서는 02:00 (KST) 에 배치 프로그램으로 헤딩 API 조회 후, 프로필 정보를 업데이트합니다. (상용, 샌드박스 공통)

프로필 이미지 사이즈 규정은 아래와 같습니다.

• 최소 160 x 160px
• 정사각형 비율의 형태
• 모서리 코너 값 및 테두리 아웃라인은 기본 적용됨

Request URL¶

Request body¶

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

Response body¶

• Data 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" ...]

Response 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¶

Request body¶

• Method type: POST

• Parameters

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

Request sample¶

{
    "pid" : "20000010000"
}

Response body¶

• Datat 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

Response code¶

Response sample¶

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