연동 가이드 Integration Guide > /wiki/spaces/KS4GFP/pages/533921827

minLevel	1
maxLevel	1
outline	false
type	list
printable	false

/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파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류	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: 탈퇴 대기 상태 (제재/보호조치 상태는 포함되지 않으며, 탈퇴 완료된 플레이어는 조회되지 않습니다.)
info	PlayerInfo	유저 상세 정보

PlayerInfo

Name	Type	Description
nickname	String	닉네임
lang	String	언어코드
data	Map<String,Object>	부가 정보
lastLoginTime	Long	마지막 로그인 시각

Example Request

코드 블럭

language	json

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

코드 블럭

language	json

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 인증 에러.
HTTP/1.1 401

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

// 플레이어 정보 없음 (-10005)
HTTP/1.1 406 Not Acceptable
{
    "desc": "There is no player. (406.-10005)"
}

...

/member/player-list

Description

플레이어 리스트 조회

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	앱 시크릿
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG 앱 아이디

Request Parameters

Name

Type

Mandatory

Description

playerIds

List<String>

N

플레이어 아이디 리스트

idpCode

N

Idp 인증 수단 이름.

(kakaocapri: 카카오, google: 구글, facebook: 페이스북,

siwa: 애플, twitter: 트위터)

idpIds

List<String>

N

idpId (최대 조회 가능 playerId : 1000개)

Response Status Code

Status Code	Status Code 설명	Status Code 상세 설명
200	정상 응답	정상
400	Bad Request	파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류
401	Unauthenticated	인증 실패
406	Not Acceptable	처리 불가
500	Internal Server Error	서버 시스템 내부 오류
503	Service Unavailable	서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

Response Content

Name	Type	Description
players	Map<String, List<Map<String, Player>>>	플레이어 리스트 정보

Player

Name	Type	Description
kgAppId	String	KG 앱 아이디
playerId	String	플레이어 아이디
status	String	플레이어 상태 normal: 정상 delete: 탈퇴 대기 상태 (제재/보호조치 상태는 포함되지 않으며, 탈퇴 완료된 플레이어는 조회되지 않습니다.)
info	PlayerInfo	유저 상세 정보

PlayerInfo

Name	Type	Description
nickname	String	닉네임
data	Map<String,Object>	부가 정보
lastLoginTime	Long	마지막 로그인 시각

Example Request

코드 블럭

language	json

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

...

코드 블럭

language	json

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

코드 블럭

language	json

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

// playerIds 조회 > 응답 결과 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 조회 > 응답 결과 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"
                }                  
            }              
        }
    ]
}

// 플레이어 정보 없음
HTTP/1.1 406 Not Acceptable

{
    "desc": "There is no player. (406.-10005)"
}

...

/member/player/member-key

Description

플레이어의 멤버키 조회

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	앱 시크릿
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG 앱 아이디

Request Parameters

Name	Type	Mandatory	Description
playerId	String	Y	플레이어 아이디

Response Status Code

Status Code	Status Code 설명	Status Code 상세 설명
200	정상 응답	정상
400	Bad Request	파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류
401	Unauthenticated	인증 실패
406	Not Acceptable	처리 불가
500	Internal Server Error	서버 시스템 내부 오류
503	Service Unavailable	서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

Response Content

Name

Type

Description

memberKeyMap

Map<String, String>

멤버키 맵

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

value : memberKey

Example Request

코드 블럭

language	json

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

코드 블럭

language	json

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

{
  "memberKeyMap": {
    "kakaocapri": "KSa5X29vLQONBFWdPGu6ji_FQThn3.U3gdoLVUBHpFzMZtsEEhGHmcBocceNJc_H"
  }
}


// 플레이어 정보 없음
HTTP/1.1 406 Not Acceptable
{
  "desc": "There is no player. (406.-10005)"
}

...

/member/uuid/player-id

Description

kgAppId와 UUID를 입력받아서 해당하는 playerId를 리턴합니다.

Method

POST

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	앱 시크릿
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG 앱 아이디

Request Parameters

Name	Type	Mandatory	Description
UUID	String	Y	UUID v4 형식 String

Response Status Code

Status Code	Status Code 설명	Status Code 상세 설명
200	정상 응답	정상
400	Bad Request	파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류
401	Unauthenticated	인증 실패
406	Not Acceptable	처리 불가
500	Internal Server Error	서버 시스템 내부 오류
503	Service Unavailable	서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

Response Content

Name	Type	Description
playerId	String	UUID에 해당하는 플레이어

Example Request

코드 블럭

language	json

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

코드 블럭

language	json

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8  
{
    "playerId": "314621196361"
}

...

/member/idp/info-list

Description

플레이어의 idp정보 목록 조회

Method

GET

Request Headers

Name	Type	Mandatory	Description
Content-Type	String	Y	"application/json;charset=UTF-8"
appSecret	String	Y	앱 시크릿
Authorization	String	Y	Authorization: KakaoAK {ADMIN_KEY}
kgAppId	String	Y	KG 앱 아이디

Request Parameters

Name	Type	Mandatory	Description
playerId	String	Y	플레이어 아이디

Response Status Code

Status Code	Status Code 설명	Status Code 상세 설명
200	정상 응답	정상
400	Bad Request	파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류
401	Unauthenticated	인증 실패
406	Not Acceptable	처리 불가
500	Internal Server Error	서버 시스템 내부 오류
503	Service Unavailable	서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

Response Content

Name	Type	Description
idpInfoList	List<IdpInfo>	IdpInfo 리스트

IdpInfo

Name

Type

Description

idpCode

String

idpCode 값

카카오 : kakaocapri
페이스북 : facebook
애플 : siwa
구글 : google
트위터 : twitter
게스트 : zd3
테스트 : dummy

idpId

String

idp Id

countryCode

String

두자리 소문자 국가코드

Example Request

코드 블럭

language	json

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

코드 블럭

language	json

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

{
  "idpInfoList": [
    {
      "idpCode": "dummy",
      "idpId": "1567694136",
      "countryCode": "kr"
    }
  ]
}


// 플레이어 정보 없음
HTTP/1.1 406 Not Acceptable
{
  "desc": "Corresponding Idp player information does not exist. (406.-10012)",
  "content": {}
}

...

버전	이전 버전 1	새 버전 2
변경한 사람	gameplatform1	QATEAM
에 저장	8월 08, 2024	8월 23, 2024

Content Comparison

버전 비교

키

/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