Integration Guide > https://kakaogames.atlassian.net/wiki/x/Bw8GLw

/member/player

Description

Player Query

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	App Secret
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG App Id

Request Parameters

Name	Type	Mandatory	Description
playerId	String	Y	Player Id

Response Status Code

Status Code	Status Code Description	Status Code Detailed Description

Status Code	Status Code Description	Status Code Detailed Description
200	Normal Response	Normal
400	Bad Request	Unparsable request data, missing mandatory parameters, or parameter type error
401	Unauthenticated	Authentication Failed
406	Not Acceptable	Cannot process
500	Internal Server Error	Internal server system error
503	Service Unavailable	Service unavailable (e.g., internal server timeout)

Response Content

Name	Type	Description

Name	Type	Description
kgAppId	String	KG App Id
playerId	String	Player Id
status	String	Player status normal: normal delete: pending unregistration (Sanctions or protection measures are not included, and players who have completed withdrawal are not included in the query.)
info	PlayerInfo	Detailed player information

PlayerInfo

Name	Type	Description

Name	Type	Description
nickname	String	Nickname
lang	String	Language code
data	Map<String,Object>	Additional information
lastLoginTime	Long	Last login time

Example Request

GET /service/v5/member/player?playerId=255331998494720 HTTP/1.1
Host: kr-openapi-zinny3.game.kakao.com:10443
Content-Type: application/json;charset=UTF-8 
appSecret: c3c38bbfa3828b342d946e9770c974d0
Authorization: KakaoAK 37faf519f278646a58a30ed73e6f8a61
kgAppId: 909428

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8  

{
    "kgAppId": "909428",
    "playerId": "255331998494720",
    "status": "normal",
    "info": {
        "nickname": "kakaogames-1684393113872",
        "lang" : "KO"
        "lastLoginTime": 1684393114000
   }
}  

// accessToken authentication error.
HTTP/1.1 401

{
    "desc": "Invalid player token. (401.-20007)"
}  

// No player information (-10005)
HTTP/1.1 406 Not Acceptable
{
    "desc": "There is no player. (406.-10005)"
}

/member/player-list

Description

Retrieve a list of players.

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	App Secret
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG App Id

Request Parameters

Name	Type	Mandatory	Description

Name

Type

Mandatory

Description

playerIds

List<String>

N

List of Player Ids

idpCode

N

Idp authentication method name.

(kakaocapri: Kakao, google: Google, facebook: Facebook,

siwa: Apple, twitter: Twitter)

idpIds

List<String>

N

idpId (maximum query limit: 1000 player IDs)

Response Status Code

Status Code	Status Code Description	Status Code Detailed Description

Status Code	Status Code Description	Status Code Detailed Description
200	Normal Response	Normal
400	Bad Request	Unparsable request data, missing mandatory parameters, or parameter type error
401	Unauthenticated	Authentication Failed
406	Not Acceptable	Cannot process
500	Internal Server Error	Internal server system error
503	Service Unavailable	Service unavailable (e.g., internal server timeout)

Response Content

Name	Type	Description

Name	Type	Description
players	Map<String, List<Map<String, Player>>>	List of player information

Player

Name	Type	Description

Name	Type	Description
kgAppId	String	KG App Id
playerId	String	Player Id
status	String	Player status normal: normal delete: pending unregistration (Sanctions or protection measures are not included, and players who have completed withdrawal are not included in the query.)
info	PlayerInfo	Player detailed information

PlayerInfo

Name	Type	Description

Name	Type	Description
nickname	String	Nickname
data	Map<String,Object>	Additional Information
lastLoginTime	Long	Last login time

Example Request

GET /service/v5/member/player-list?playerIds=156176766994432,156176766994123 HTTP/1.1
Host: kr-openapi-zinny3.game.kakao.com:10443
Content-Type: application/json;charset=UTF-8 
appSecret: c3c38bbfa3828b342d946e9770c974d0
Authorization: KakaoAK 37faf519f278646a58a30ed73e6f8a61
kgAppId: 909428

Example Response

/member/player/member-key

Description

Query player member keys

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	App secret
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG App Id

Request Parameters

Name	Type	Mandatory	Description
playerId	String	Y	Player Id

Response Status Code

Status Code	Status Code Description	Status Code Detailed Description

Status Code	Status Code Description	Status Code Detailed Description
200	Normal Response	Normal
400	Bad Request	Unparsable request data, missing mandatory parameters, or parameter type error
401	Unauthenticated	Authentication Failed
406	Not Acceptable	Cannot process
500	Internal Server Error	Internal server system error
503	Service Unavailable	Service unavailable (e.g., internal server timeout)

Response Content

Name	Type	Description

Name

Type

Description

memberKeyMap

Map<String, String>

Member key map

key : idpCode (kakaocapri, google, facebook, zd3 etc..)

value : memberKey

Example Request

Example Response

/member/uuid/player-id

Description

Retrieve playerId using kgAppId and UUID.

Method

POST

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	App Secret
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG App Id

Request Parameters

Name	Type	Mandatory	Description
UUID	String	Y	UUID v4 formatted string

Response Status Code

Status Code	Status Code Description	Status Code Detailed Description

Status Code	Status Code Description	Status Code Detailed Description
200	Normal Response	Normal
400	Bad Request	Unparsable request data, missing mandatory parameters, or parameter type error
401	Unauthenticated	Authentication Failed
406	Not Acceptable	Cannot process
500	Internal Server Error	Internal server system error
503	Service Unavailable	Service unavailable (e.g., internal server timeout)

Response Content

Name	Type	Description

Name	Type	Description
playerId	String	Player Id corresponding to UUID

Example Request

Example Response

/member/idp/info-list

Description

Retrieve a list of IDP information of a player.

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	App Secret
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG App Id

Request Parameters

Name	Type	Mandatory	Description
playerId	String	Y	Player Id

Response Status Code

Status Code	Status Code Description	Status Code Detailed Description

Status Code	Status Code Description	Status Code Detailed Description
200	Normal Response	Normal
400	Bad Request	Unparsable request data, missing mandatory parameters, or parameter type error
401	Unauthenticated	Authentication Failed
406	Not Acceptable	Cannot process
500	Internal Server Error	Internal server system error
503	Service Unavailable	Service unavailable (e.g., internal server timeout)

Response Content

Name	Type	Description

Name	Type	Description
idpInfoList	List<IdpInfo>	IdpInfo list

IdpInfo

Name	Type	Description

Name

Type

Description

idpCode

String

idpCode value

Kakao: kakaocapri
Facebook : facebook
Apple : siwa
Google : google
Twitter : twitter
Guest : zd3
Test : dummy

idpId

String

idp Id

countryCode

String

Two-letter lowercase country code.

Member (/member)

/member/player

Description

Method

Request Headers

Request Parameters

Response Status Code

Response Content

PlayerInfo

Example Request

Example Response

/member/player-list

Description

Method

Request Headers

Request Parameters

Response Status Code

Response Content

Player

PlayerInfo

Example Request

Example Response

/member/player/member-key

Description

Method

Request Headers

Request Parameters

Response Status Code

Response Content

Example Request

Example Response

/member/uuid/player-id

Description

Method

Request Headers

Request Parameters

Response Status Code

Response Content

Example Request

Example Response

/member/idp/info-list

Description

Method

Request Headers

Request Parameters

Response Status Code

Response Content

IdpInfo

Example Request

Example Response

Related content