Integration Guide > /wiki/spaces/KS4GFP/pages/533921827
/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 |
|---|---|---|
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 Error |
503 | Service Unavailable | Service unavailable (e.g., internal server timeout) |
Response Content
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 |
|---|---|---|
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 |
|---|---|---|---|
playerIds | List<String> | N | List of Player Ids |
idpCode | 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 |
|---|---|---|
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 Error |
503 | Service Unavailable | Service unavailable (e.g., internal server timeout) |
Response Content
Name | Type | Description |
|---|---|---|
players | Map<String, List<Map<String, Player>>> | List of player information |
Player
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 |
|---|---|---|
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 |
GET /service/v5/member/player-list?idpCode=kakaocapri&idpIds=1234567,2222222 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
// playerIds query > response playerId key
{
"players": [
{
"156176766994432": {
"kgAppId": "909428",
"playerId": "156176766994432",
"status": "normal",
"nickname": "kakaogames-1672048155324",
"lang": "ko",
"data": {
"country": "kr",
"deviceId": "1234567890qwerasdfzxcv"
}
}
},
{
"156176766994123": {
"kgAppId": "909428",
"playerId": "156176766994123",
"status": "normal",
"nickname": "kakaogames-1672048155324",
"lang": "ko",
"data": {
"country": "kr",
"deviceId": "1234567890qwerasdfzxcv"
}
}
}
]
}
// idpIds query > response idpId key
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"players": [
{
"1234567": {
"kgAppId": "909428",
"playerId": "156176766994432",
"status": "normal",
"nickname": "kakaogames-1672048155324",
"lang": "ko",
"data": {
"country": "kr",
"deviceId": "1234567890qwerasdfzxcv"
}
}
},
{
"2222222": {
"kgAppId": "909428",
"playerId": "156176766994123",
"status": "normal",
"nickname": "kakaogames-1672048155324",
"lang": "ko",
"data": {
"country": "kr",
"deviceId": "1234567890qwerasdfzxcv"
}
}
}
]
}
// No player information
HTTP/1.1 406 Not Acceptable
{
"desc": "There is no player. (406.-10005)"
}
|
/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 |
|---|---|---|
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 Error |
503 | Service Unavailable | Service unavailable (e.g., internal server timeout) |
Response Content
Name | Type | Description |
|---|---|---|
memberKeyMap | Map<String, String> | Member key map key : idpCode (kakaocapri, google, facebook, zd3 etc..) value : memberKey |
Example Request
GET /service/v5/member/player/member-key?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
{
"memberKeyMap": {
"kakaocapri": "KSa5X29vLQONBFWdPGu6ji_FQThn3.U3gdoLVUBHpFzMZtsEEhGHmcBocceNJc_H"
}
}
// No player information
HTTP/1.1 406 Not Acceptable
{
"desc": "There is no player. (406.-10005)"
}
|
/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 |
|---|---|---|
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 Error |
503 | Service Unavailable | Service unavailable (e.g., internal server timeout) |
Response Content
Name | Type | Description |
|---|---|---|
playerId | String | Player Id corresponding to UUID |
Example Request
POST /service/v5/member/uuid/player-id 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
{
"UUID": "cd14f364-e82a-4839-9ae8-e4c7e8921837"
}
|
Example Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"playerId": "314621196361"
}
|
/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 |
|---|---|---|
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 Error |
503 | Service Unavailable | Service unavailable (e.g., internal server timeout) |
Response Content
Name | Type | Description |
|---|---|---|
idpInfoList | List<IdpInfo> | IdpInfo list |
IdpInfo
Name | Type | Description |
|---|---|---|
idpCode | String | idpCode value Kakao: kakaocapri |
idpId | String | idp Id |
countryCode | String | Two-letter lowercase country code. |
Example Request
GET /service/v5/member/idp/info-list?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
{
"idpInfoList": [
{
"idpCode": "dummy",
"idpId": "1567694136",
"countryCode": "kr"
}
]
}
// No player information
HTTP/1.1 406 Not Acceptable
{
"desc": "Corresponding Idp player information does not exist. (406.-10012)",
"content": {}
}
|
0 댓글