버전 비교

  • 이 줄이 추가되었습니다.
  • 이 줄이 삭제되었습니다.
  • 서식이 변경되었습니다.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

게임플랫폼 백엔드 HTTP API를 제공합니다.

...

앱별로 발급되는 인증키(appSecret)를 사용하여 높은 수준의 보안성 제공

...

게임센터 파트너 어드민에 등록된 adminKey를 Authorization 헤더 값으로 입력

...

내부적 fully asynchronous 구조를 사용하여 고효율 대량 트래픽 처리

...

게임플랫폼 openApi 내부 timeout 기본 5초

...

게임 서버에서 Sever to Server API 호출시에는 전용 포트(10443) 사용

...

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) : 게임서버가 아닌 카카오게임 플랫폼의 환경을 의미합니다. 게임서버 Live 에서 사용해야 합니다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

Key

Description

비고Remarks

Content-Type

Content type

“application/json;charset=UTF-8”

appSecret

게임마다 발급 받은 secretKey (Native App Key) 앱 시크릿issued for each game

App Secret

Authorization게임 센터에 등록된 adminKey를 사용

Use the adminKey registered in the Game Center.

KakaoAK {adminKey}

Authorization: KakaoAK {adminKey}

예제Ex) Authorization: KakaoAK c0948035a320f23423585acae3dedcd70

kgAppId

KG 앱 아이디KG에서 발급한 앱단위 아이디 (현재 카카오 App Id

App-level ID issued by KG (currently Kakao appId)

platform접속

플랫폼Access platform

web, launcher, mobile, pc

playerId플레이어

아이디Player Id

Request Body

Body는 JSON 형식을 갖습니다The Body is in JSON format.

Response

정상적으로 수행이 되었을 경우 Http Status Code는 항상 200 OK이며 JSON 형태의 리턴 값을 body로 받습니다.

예외의 경우 4xx 혹은 5xx Status Code로 응답되며, body의 desc를 포함한 필요한 데이터가 리턴됩니다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.