Server to Server API
Introduction
Provides the game platform backend HTTP API.
Offers high-level security using an authentication key (appSecret) issued for each app.
Use the adminKey registered in the Game Center Partner Admin as the Authorization header value.
Utilizes a fully asynchronous internal structure to handle high-efficiency large-scale traffic.
The default timeout for the game platform openApi is 5 seconds.
When calling the Server to Server API from the game server, use the dedicated port (10443).
These APIs are server-only and restricted from being called by game clients.
API
Resource FQDN (Fully Qualified Domain Name)
Zone | URL |
---|---|
Live | Global domain Korea-specific Domain (if the game server is built in Korea) |
Live (Real) : Refers to the environment of the Kakao Game Platform, not the game server. It must be used in the game server Live environment.
Resource Path
/service/{version}/{platform}/{api}
Request Header
The adminKey can be checked in the Game Center (https://gamecenter.kakao.com).
Key | Description | Remarks |
Content-Type | Content type | “application/json;charset=UTF-8” |
appSecret | secretKey (Native App Key) issued for each game | App Secret |
Authorization | Use the adminKey registered in the Game Center. KakaoAK {adminKey} | Authorization: KakaoAK {adminKey} Ex) Authorization: KakaoAK c0948035a320f23423585acae3dedcd70 |
kgAppId | KG App Id | App-level ID issued by KG (currently Kakao appId) |
platform | Access platform | web, launcher, mobile, pc |
playerId | Player Id |
|
Request Body
The Body is in JSON format.
Response
If performed successfully, the HTTP Status Code is always 200 OK, and the return value is received as a JSON body.
In case of exceptions, a 4xx or 5xx Status Code is returned, along with necessary data including the desc in the body.