서버 API
소개
게임플랫폼 백엔드 HTTP API를 제공합니다.
앱별로 발급되는 인증키(appSecret)를 사용하여 높은 수준의 보안성 제공
게임센터 파트너 어드민에 등록된 adminKey를 Authorization 헤더 값으로 입력
내부적 fully asynchronous 구조를 사용하여 고효율 대량 트래픽 처리
게임플랫폼 openApi 내부 timeout 기본 5초
게임 서버에서 Sever to Server API 호출시에는 전용 포트(10443) 사용
해당 API들은 서버 전용이며 게임 클라이언트 호출 제한
API
Resource FQDN (Fully Qualified Domain Name)
Zone | URL |
---|---|
Live | 글로벌 도메인 한국 전용 도메인 (게임서버가 한국에 구축되어 있는 경우) |
Live (Real) : 게임서버가 아닌 카카오게임 플랫폼의 환경을 의미합니다. 게임서버 Live 에서 사용해야 합니다.
Resource Path
/service/{version}/{플랫폼}/{api}
Request Header
adminKey 는 게임센터(https://gamecenter.kakao.com)에서 확인 가능 합니다.
Key | Description | 비고 |
Content-Type | Content type | “application/json;charset=UTF-8” |
appSecret | 게임마다 발급 받은 secretKey (Native App Key) | 앱 시크릿 |
Authorization | 게임 센터에 등록된 adminKey를 사용 KakaoAK {adminKey} | Authorization: KakaoAK {adminKey} 예제) Authorization: KakaoAK c0948035a320f23423585acae3dedcd70 |
kgAppId | KG 앱 아이디 | KG에서 발급한 앱단위 아이디 (현재 카카오 appId) |
platform | 접속 플랫폼 | web, launcher, mobile, pc |
playerId | 플레이어 아이디 |
|
Request Body
Body는 JSON 형식을 갖습니다.
Response
정상적으로 수행이 되었을 경우 Http Status Code는 항상 200 OK이며 JSON 형태의 리턴 값을 body로 받습니다.
예외의 경우 4xx 혹은 5xx Status Code로 응답되며, body의 desc를 포함한 필요한 데이터가 리턴됩니다.