Profile API

The profile API is used when operating the 'Community Profile' independently in the community console or linking the 'Game Profile' with the 'Community Profile'.

Preparation¶

You need to register the API that links according to the type of profile you want to use by clicking on the community profile in the console.

• When using only the community profile, register the default profile image API
• When linking the game profile, register the game profile API

For more details, please refer to the Profile API integration in the console.

Basic profile image API¶

The default profile image API is used to change the default profile image when only the community profile type is used in the community profile, as shown below.

When you request the default profile image API, the server will update the profile information after querying the heading API with a batch program at 02:00 (KST). (Common for production and sandbox)

The profile image size regulations are as follows.

• Minimum 160 x 160px
• Square aspect ratio
• Corner values and border outlines are applied by default

Request URL¶

Request body¶

• Method type: POST
• Parameters
  • No parameters

Response body¶

• Data type: Json

• Parameters

  Name	Description	TYPE	Value
  result	Result value	JSON Object
  result.code	Result code (100 : Success)	Integer	100
  result.msg	Result message	String
  params	Parameters	JSON Object
  params.total	Number of items in the list	int	10
  params.list	List (Image URL)	String Array	["https://test-img.co.kr/profile1.jpg","https://test-img.co.kr/profile2.jpg" ...]

Response code¶

• Please ensure success is delivered as 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"
        ]
    }
}

Game profile API¶

The game profile API is used when linking the community profile to the game profile in the same way as below.

The community profile linked to the game profile will be updated when the community manager logs into the community.

Request URL¶

Request body¶

• Method type: POST

• Parameters

  Field Name	Description	Type	Required
  pid	User's PlayerID	string	Y

Request sample¶

{
    "pid" : "20000010000"
}

Response body¶

• Data type: Json

• Parameters

  Name	Description	Type	Value
  result	Result value	JSON Object
  result.code	Result code (100: Success)	Integer	100
  result.msg	Result message	String
  params	Parameters	JSON Object
  params.pid	User's PlayerID	String	20000010000
  params.nickname	User's nickname	String	Hong Gil-dong
  params.p_image	User's profile 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"
    }
}