카카오게임 관리

신규 어드민 API 제공

이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.

이 문서는 카카오게임 앱 관리 어드민 API의 사용 방법을 안내합니다.

제목 태그

각 제목에 부착된 태그(Tag)는 아래와 같은 의미입니다.

태그	설명
Internal	이 액션은 API플랫폼 내부에서만 사용합니다.

게임 앱 관리

요청

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/game`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL Internal	게임 앱 목록을 조회합니다.
CREATE Internal	새 게임 앱을 등록합니다.

FIND_ALL
Internal

게임 앱 목록을 조회합니다.

payload 하위 파라미터에 조회 조건을 전달해야 합니다.

요청 처리 성공 시 응답은 게임 앱 기본 정보 목록을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
app_type	`String`	앱 타입 (기본값: `PARTNER`)	X
app_category	`String`	앱 카테고리 (기본값: `Games`)	X
ascending	`Boolean`	오름차순 여부 `true`: 오름차순 `false`: 내림차순 (기본값: `true`)	X
from_id	`Int`	조회 시작 지점이 될 앱 ID (기본값: 0)	X

응답 페이로드

이름	타입	설명	필수
from	`Long`	조회 시작 지점 앱 ID	O
size	`Int`	페이지당 앱 수	O
next	`Long`	다음 페이지 시작 지점 앱 ID	X
count	`Long`	현재 페이지 게임 앱 수	O
data	`Game[]`	게임 앱 목록	O
total	`Long`	조회된 전체 게임 앱 수	X

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
{
  "from": 0,
  "size": 100,
  "next": 291477,
  "count": 5,
  "data": [
    {
      "id": 287051,
      "name": "GameTestApp",
      "company": "(주)카카오",
      "app_type": "PARTNER",
      "app_category": "Games",
      "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
      "status": "ACTIVE",
      "registered_at": "2015-09-10T18:22:49Z",
      "owner_developer": {
        "id": 47033,
        "name": "테스트",
        "account_id": 261534,
        "registered_at": "2014-01-13T12:02:06Z"
      }
    }
    // ...
  ],
  "total": 16207
}

CREATE
Internal

새 게임 앱을 등록합니다.

payload 하위 파라미터에 추가할 게임 앱 정보, 소유자인 개발자 계정 ID를 전달해야 합니다.

요청 처리 성공 시 응답은 추가된 게임 앱 정보를 payload에 포함합니다.

요청 페이로드

값	타입	설명	필수
game_app	`GameApp`	게임 앱 정보	O
owner_developer_id	`Int`	앱 소유자인 개발자 계정 ID	O

GameApp

값	타입	설명	필수
name	`String`	앱 이름	O
company	`String`	회사명(영문 기준 최대 50자)	O
app_type	`String`	앱 타입 `PARTNER`로 고정	X
app_category	`String`	앱 카테고리 `Games`로 고정	X
icon_image_kage_token	`String`	앱 아이콘 이미지의 KAGE 토큰	X
use_unique_nickname	`Boolean`	고유 닉네임 사용 여부 `true`: 사용 `false`: 미사용 (기본값: `false`)	X
auto_regi	`Boolean`	자동 연결 사용 여부 `true`: 사용 `false`: 미사용 (기본값: `true`)	X
pf	`Platform`	지원하는 플랫폼 정보	X
ae	`AppExtension`	추가 설정 정보	X

응답 페이로드

Game

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "CREATE",
        "payload": {
            "owner_developer_id": 576950,
            "game_app": {
                "name": "게임앱테스트",
                "company": "테스트"
            }
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "ACTIVE",
  "registered_at": "2023-07-18T15:17:15Z",
  "owner_developer": {
    "id": 576950,
    "name": "테스트",
    "account_id": 2137134,
    "registered_at": "2020-02-17T15:43:02Z"
  },
  "app_key": {
    "JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
    "ADMIN_KEY": "${ADMIN_KEY}",
    "REST_API_KEY": "${REST_API_KEY}",
    "NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
  },
  "use_unique_nickname": false,
  "auto_regi": true,
  "ae": {
    "age_limit": 0,
    "age_auth_level": "NONE",
    "plus_friend_ids": "23123"
  }
}

개별 게임 앱 관리

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/game/:app_id`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND Internal	특정 게임 앱 정보를 조회합니다.
UPDATE Internal	특정 게임 앱 정보를 수정합니다.
REMOVE_PLATFORM Internal	특정 게임 앱의 한 플랫폼 설정을 삭제합니다.
REMOVE_ALL_PLATFORM Internal	특정 게임 앱의 모든 플랫폼 설정을 삭제합니다.
DELETE Internal	특정 게임 앱을 삭제합니다.

FIND
Internal

특정 게임 앱 정보를 조회합니다.

요청 처리 성공 시 응답은 게임 앱 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

GameApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game/:app_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "ACTIVE",
  "registered_at": "2023-07-18T15:17:15Z",
  "owner_developer": {
    "id": 576950,
    "name": "테스트",
    "account_id": 2137134,
    "registered_at": "2020-02-17T15:43:02Z"
  },
  "app_key": {
    "JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
    "ADMIN_KEY": "${ADMIN_KEY}",
    "REST_API_KEY": "${REST_API_KEY}",
    "NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
  },
  "use_unique_nickname": false,
  "auto_regi": true,
  "ae": {
    "age_limit": 0,
    "age_auth_level": "NONE",
    "plus_friend_ids": "23123"
  }
}

UPDATE
Internal

특정 게임 앱 정보를 수정합니다.

payload 하위 파라미터에 수정할 게임 앱 정보, 소유자인 개발자 계정 ID를 전달해야 합니다.

요청 처리 성공 시 응답은 수정된 게임 앱 정보를 payload에 포함합니다.

요청 페이로드

값	타입	설명	필수
game_app	`GameApp`	게임 앱 정보	O
owner_developer_id	`Int`	앱 소유자인 개발자 계정 ID	O

GameApp

값	타입	설명	필수
name	`String`	앱 이름	X
company	`String`	회사명(영문 기준 최대 50자)	X
icon_image_kage_token	`String`	앱 아이콘 이미지의 KAGE 토큰	X
use_unique_nickname	`Boolean`	고유 닉네임 사용 여부 `true`: 사용 `false`: 미사용 (기본값: `false`)	X
auto_regi	`Boolean`	자동 연결 사용 여부 `true`: 사용 `false`: 미사용 (기본값: `true`)	X
pf	`Platform`	지원하는 플랫폼 정보	X
ae	`AppExtension`	추가 설정 정보	X

응답 페이로드

GameApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game/:app_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "owner_developer_id": 576950,
            "game_app": {
                "name": "게임앱테스트이름수정",
                "company": "테스트",
                "pf": {
                    "android_package_name": "aaa.bbb.ccc",
                    "android_market_url": "https://developers.kakao.com",
                    "ios_bundle_id": "aaa.bbb.ccc",
                    "iphone_app_store_id": 1234,
                    "iphone_market_url": "https://developers.kakao.com"
                }
            }
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트이름수정",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "ACTIVE",
  "registered_at": "2023-07-18T15:17:15Z",
  "owner_developer": {
    "id": 576950,
    "name": "테스트",
    "account_id": 2137134,
    "registered_at": "2020-02-17T15:43:02Z"
  },
  "app_key": {
    "JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
    "ADMIN_KEY": "${ADMIN_KEY}",
    "REST_API_KEY": "${REST_API_KEY}",
    "NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
  },
  "use_unique_nickname": false,
  "auto_regi": true,
  "pf": {
    "android_package_name": "aaa.bbb.ccc",
    "android_market_url": "https://developers.kakao.com",
    "ios_bundle_id": "aaa.bbb.ccc",
    "iphone_app_store_id": 1234,
    "iphone_market_url": "https://developers.kakao.com"
  },
  "ae": {
    "age_limit": 0,
    "age_auth_level": "NONE",
    "plus_friend_ids": "23123"
  }
}

REMOVE_PLATFORM
Internal

특정 게임 앱의 한 플랫폼 설정을 삭제합니다.

요청 처리 성공 시 응답은 수정된 게임 앱 정보를 payload에 포함합니다.

요청 페이로드

값	타입	설명	필수
params	`String[]`	삭제할 데이터의 키 배열 사용 가능한 키는 `Platform` 참고	O

Platform

값	설명
pf.android_package_name	Android 패키지 이름
pf.android_market_url	Android 오픈마켓 URL
pf.ios_bundle_id	iOS 번들 ID
pf.iphone_app_store_id	iPhone 앱스토어 ID
pf.iphone_market_url	iPad 앱스토어 URL
pf.ipad_app_store_id	iPad 앱스토어 ID
pf.ipad_market_url	iPad 앱스토어 URL
pf.website_url	웹사이트 URL
ae.android_released_at	Android 출시일
ae.ios_released_at	iOS 출시일
ae.web_released_at	웹 출시일

응답 페이로드

GameApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game/:app_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "REMOVE_PLATFORM",
        "payload": {
            "params": [\"pf.android_package_name\", \"pf.android_market_url\", \"ae.android_released_at\"]
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트이름수정",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "ACTIVE",
  "registered_at": "2023-07-18T15:17:15Z",
  "owner_developer": {
    "id": 576950,
    "name": "테스트",
    "account_id": 2137134,
    "registered_at": "2020-02-17T15:43:02Z"
  },
  "app_key": {
    "JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
    "ADMIN_KEY": "${ADMIN_KEY}",
    "REST_API_KEY": "${REST_API_KEY}",
    "NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
  },
  "use_unique_nickname": false,
  "auto_regi": true,
  "pf": {
    "ios_bundle_id": "aaa.bbb.ccc",
    "iphone_app_store_id": 1234,
    "iphone_market_url": "https://developers.kakao.com"
  },
  "ae": {
    "age_limit": 0,
    "age_auth_level": "NONE",
    "plus_friend_ids": "23123"
  }
}

REMOVE_ALL_PLATFORM
Internal

특정 게임 앱의 모든 플랫폼 설정을 삭제합니다.

요청 처리 성공 시 응답은 수정된 게임 앱 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

GameApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game/:app_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "REMOVE_ALL_PLATFORM"
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "ACTIVE",
  "registered_at": "2023-07-18T15:17:15Z",
  "owner_developer": {
    "id": 576950,
    "name": "테스트",
    "account_id": 2137134,
    "registered_at": "2020-02-17T15:43:02Z"
  },
  "app_key": {
    "JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
    "ADMIN_KEY": "${ADMIN_KEY}",
    "REST_API_KEY": "${REST_API_KEY}",
    "NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
  },
  "use_unique_nickname": false,
  "auto_regi": true,
  "ae": {
    "age_limit": 0,
    "age_auth_level": "NONE",
    "plus_friend_ids": "23123"
  }
}

DELETE
Internal

특정 게임 앱을 삭제합니다.

요청 처리 성공 시 응답은 삭제된 게임 앱 기본 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

Game

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/game/:app_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "id": 1349040,
  "name": "게임앱테스트이름수정",
  "company": "테스트",
  "app_type": "PARTNER",
  "app_category": "Games",
  "icon_image_kage_token": "http://alpha-k.kakaocdn.net/14/dn/ZSdVOOpn0s/TPwVXsol2dfJiQsGeJG8pk/o.jpg",
  "status": "DEACTIVATED",
  "registered_at": "2023-07-18T15:17:15Z",
  "deactivated_at": "2023-07-18T15:49:49Z"
}

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

카카오게임 관리

제목 태그

게임 앱 관리

요청

액션

FIND_ALLInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CREATEInternal

요청 페이로드

GameApp

응답 페이로드

요청 예제

응답 예제

개별 게임 앱 관리

요청

액션

FINDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATEInternal

요청 페이로드

GameApp

응답 페이로드

요청 예제

응답 예제

REMOVE_PLATFORMInternal

요청 페이로드

Platform

응답 페이로드

요청 예제

응답 예제

REMOVE_ALL_PLATFORMInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

DELETEInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

도움이 되었나요?