내 애플리케이션: 서비스 설정

신규 어드민 API 제공

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

이 문서는 카카오디벨로퍼스 앱(애플리케이션)의 서비스 정보에 대한 어드민 API 사용 방법을 안내합니다.

서비스

요청

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

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

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

액션

이름	설명
FIND_ALL_SERVICE	앱에 등록된 모든 서비스 타입을 조회합니다.
FIND_ALL	앱에 등록된 모든 서비스의 기본 정보를 조회합니다.
FIND	앱에 등록된 특정 서비스 정보를 조회합니다.
FIND_STATUS	앱에 등록된 특정 서비스의 상태를 조회합니다.
UPDATE	앱의 특정 서비스 설정을 변경합니다.
DELETE	앱에 등록된 특정 서비스를 비활성화합니다.

FIND_ALL_SERVICE

앱에 등록된 모든 서비스 타입을 조회합니다.

이 액션은 앱에 등록된 모든 서비스 타입의 이름 값을 문자열 배열로 반환합니다. payload에 query.status 파라미터로 활성화 또는 비활성화된 서비스만 요청할 수 있습니다.

이 액션은 앱에 등록된 서비스 타입의 목록만 제공하므로, 각 서비스의 기본 정보는 FIND_ALL로 요청해 확인할 수 있습니다.

요청 처리 성공 시 응답은 payload에 서비스 타입 값의 배열을 포함합니다.

요청 페이로드

이름	타입	설명	필수
query.status	`String`	서비스 사용 설정 상태, 아래 중 하나 `ACTIVE`: 활성(사용 중) `DEACTIVATED`: 비활성	X

응답 페이로드

ApplicationServiceModel 중 service_type

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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_SERVICE",
        "payload": {
            "query.status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
[
  "USER_MANAGEMENT",
  "KAKAO_LINK",
  "KAKAO_TALK",
  "KPUSHER",
  "PLUS_FRIENDS"
  // ...
]

FIND_ALL

앱에 등록된 모든 서비스의 기본 정보를 조회합니다.

이 액션은 앱에 등록된 모든 서비스의 기본 정보 목록을 제공합니다. payload에 query.status 파라미터로 활성화 또는 비활성화된 서비스 목록만 요청할 수 있습니다.

요청 처리 성공 시 응답은 서비스 기본 정보의 배열을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
query.status	`String`	서비스 사용 설정 상태, 아래 중 하나 `ACTIVE`: 활성(사용 중) `DEACTIVATED`: 비활성	X

응답 페이로드

ApplicationServiceModel의 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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",
        "payload": {
            "query.status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": 977071,
    "service_type": "USER_MANAGEMENT",
    "status": "ACTIVE",
    "created_at": "2021-02-17T02:39:21Z",
    "updated_at": "2021-02-17T02:39:21Z"
  },
  {
    "app_id": 977071,
    "service_type": "KAKAO_LINK",
    "status": "ACTIVE",
    "created_at": "2020-02-21T05:42:16Z",
    "updated_at": "2020-02-21T05:42:16Z"
  },
  {
    "app_id": 977071,
    "service_type": "KAKAO_TALK",
    "status": "ACTIVE",
    "created_at": "2020-02-21T05:42:16Z",
    "updated_at": "2020-02-21T05:42:16Z"
  },
  {
    "app_id": 977071,
    "service_type": "KPUSHER",
    "status": "ACTIVE",
    "created_at": "2020-02-21T05:42:46Z",
    "updated_at": "2020-02-21T05:42:46Z"
  },
  {
    "app_id": 977071,
    "service_type": "PLUS_FRIENDS",
    "status": "ACTIVE",
    "created_at": "2020-02-21T05:42:16Z",
    "updated_at": "2020-02-21T05:42:16Z"
  }
  // ...
]

FIND

앱에 등록된 특정 서비스 정보를 조회합니다.

조회할 서비스 타입을 payload에 service 값으로 전달해야 합니다. FIND_ALL_SERVICE 또는 FIND_ALL 액션으로 조회한 서비스 타입의 값을 전달합니다.

요청 처리 성공 시 응답은 payload에 해당 서비스 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O

응답 페이로드

ApplicationServiceModel

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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",
        "payload": {
            "service": "USER_MANAGEMENT"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 955071,
  "service_type": "USER_MANAGEMENT",
  "status": "ACTIVE",
  "created_at": "2021-02-17T02:39:21Z",
  "updated_at": "2021-02-17T02:39:21Z"
}

FIND_STATUS

앱에 등록된 특정 서비스의 상태를 조회합니다.

상태를 조회할 서비스 타입을 payload에 service 값으로 전달해야 합니다. FIND_ALL_SERVICE 또는 FIND_ALL 액션으로 조회한 서비스 타입의 값을 전달합니다.

요청 처리 성공 시 응답은 payload에 해당 서비스 상태를 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O

응답 페이로드

ACTIVE(활성) 또는 DEACTIVATED(비활성) 중 하나, ApplicationServiceStatus 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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_STATUS",
        "payload": {
            "service": "USER_MANAGEMENT"
        }
    }'

응답 예제

// HTTP/2 200
"ACTIVE"

UPDATE

앱에 등록된 특정 서비스의 설정을 변경합니다.

특정 서비스의 상태 또는 사용 목적을 변경할 수 있으며, 사용 목적은 참고 정보로써 간단한 문자열을 입력할 수 있습니다.

요청 처리 성공 시 응답은 payload에 변경된 해당 서비스 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O
status	`ApplicationServiceStatus`	서비스 상태	O
purpose	`String`	사용 목적(영문 기준 최대 255자)	X

응답 페이로드

ApplicationServiceModel

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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": {
            "service": "USER_MANAGEMENT",
            "status": "ACTIVE",
            "purpose": "test"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 955071,
  "service_type": "USER_MANAGEMENT",
  "status": "ACTIVE",
  "purpose": "test",
  "created_at": "2021-02-17T02:39:21Z",
  "updated_at": "2021-11-15T09:11:43Z"
}

DELETE

앱에 등록된 특정 서비스를 비활성화합니다.

이 액션은 간단히 특정 서비스를 비활성화하기 위해 사용합니다. 서비스 상태와 함께 사용 목적을 변경하고자 할 경우, UPDATE 액션으로 요청합니다.

요청 처리 성공 시 응답은 payload에 비활성화된 서비스의 기존 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O

응답 페이로드

ApplicationServiceModel

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service" \
  -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": "DELETE",
        "payload": {
            "service": "CHANNEL"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1102854,
  "service_type": "CHANNEL",
  "status": "ACTIVE",
  "created_at": "2021-06-09T09:39:04Z",
  "updated_at": "2021-11-15T09:17:10Z"
}

서비스: 상세

요청

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

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

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

액션

이름	설명
FIND_ALL	앱에 등록된 서비스의 상세 정보를 조회합니다.
FIND	앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 조회합니다.
UPDATE	앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 변경합니다.
DELETE	앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 삭제합니다.

FIND_ALL

앱에 등록된 서비스의 상세 설정을 조회합니다.

상세 정보를 조회할 서비스 타입을 지정해 요청합니다. 앱에 설정되어 있고 활성화된 서비스에 한해 조회 가능하므로, 서비스 API의 FIND_ALL_SERVICE 또는 FIND_ALL 액션으로 서비스 상태를 확인한 후 요청할 것을 권장합니다.

요청 처리 성공 시 응답은 payload에 해당 서비스의 상세 설정을 포함합니다. 상세 정보의 구성은 서비스마다 다릅니다. 비활성화된 서비스에 대해 요청한 경우에는 payload 값에 빈 JSON이 반환됩니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O

응답 페이로드

key:value 형식의 JSON
서비스마다 다른 상세 설정 항목으로 구성되므로, 개별 확인 필요

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service/property" \
  -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",
        "payload": {
            "service": "USER_MANAGEMENT"
        }
    }'

응답 예제: 인하우스 앱의 카카오 로그인 서비스 상세 정보 조회

// HTTP/2 200
{
  "USER_MANAGEMENT_WEB_REDIRECT_URI": "https://developers.kakao.com/",
  "USER_MANAGEMENT_LAZY_AGE_AUTH": "0",
  "USER_MANAGEMENT_STORY_PROFILE_PRIORITY": "2",
  "USER_MANAGEMENT_FORCED_AGREEMENT": "0",
  "USER_MANAGEMENT_AUTO_REGISTER": "0",
  "USER_MANAGEMENT_KEEP_USER_ID": "1",
  "USER_MANAGEMENT_TALK_PROFILE_PRIORITY": "1"
}

응답 예제: 비활성화 상태인 서비스에 대한 요청

// HTTP/2 200
{}

FIND

앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 조회합니다.

각 서비스의 조회 가능한 상세 설정은 FIND_ALL 액션으로 확인할 수 있습니다.

요청 처리 성공 시 응답은 payload에 해당 상세 설정의 값을 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O
service_property	`String`	서비스 상세 설정 항목	O

응답 페이로드

요청한 서비스 상세 설정 항목 값

요청 예제: 카카오 로그인 리다이렉트 URI 조회

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service/property" \
  -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",
        "payload": {
            "service": "USER_MANAGEMENT",
            "service_property": "USER_MANAGEMENT_WEB_REDIRECT_URI"
        }
    }'

응답 예제: 카카오 로그인 리다이렉트 URI 조회

// HTTP/2 200
"https://developers.kakao.com/"

응답 예제: 해당 상세 설정에 값이 없는 경우

// HTTP/2 404
{
  "message": "${MESSAGE}"
}

UPDATE

앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 변경합니다.

요청 처리 성공 시 응답은 payload에 변경된 상세 설정 항목의 값을 포함합니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O
service_property	`String`	서비스 상세 설정 항목	O
value	`String`	변경할 상세 설정 항목의 값	O

응답 페이로드

변경된 해당 상세 설정 항목의 값

요청 예제: 카카오 로그인 리다이렉트 URI 변경

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service/property" \
  -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": {
            "service": "USER_MANAGEMENT",
            "service_property": "USER_MANAGEMENT_WEB_REDIRECT_URI",
            "value": "https://www.kakao.com/login"
        }
    }'

응답 예제: 카카오 로그인 리다이렉트 URI 변경

// HTTP/2 200
"https://www.kakao.com/login"

DELETE

앱에 등록된 서비스의 상세 설정 중 특정 항목의 값을 변경합니다.

요청 처리 성공 시 응답은 payload에 삭제한 상세 설정 항목의 값을 포함합니다. 응답에는 삭제 요청한 값이 전달되지만, FIND 액션으로 해당 항목의 값을 다시 조회하면 정상적으로 값이 삭제되었음을 확인할 수 있습니다.

요청 페이로드

이름	타입	설명	필수
service	`String`	서비스 타입 `ServiceType` 참고	O
service_property	`String`	서비스 상세 설정 항목	O

응답 페이로드

삭제된 해당 상세 설정 항목의 값

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/service/property" \
  -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": "DELETE",
        "payload": {
            "service": "USER_MANAGEMENT",
            "service_property": "USER_MANAGEMENT_WEB_REDIRECT_URI"
        }
    }'

응답 예제

// HTTP/2 200
"https://www.kakao.com/login"

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

내 애플리케이션: 서비스 설정

서비스

요청

액션

FIND_ALL_SERVICE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

FIND_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제

FIND

요청 페이로드

응답 페이로드

요청 예제

응답 예제

FIND_STATUS

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

DELETE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

서비스: 상세

요청

액션

FIND_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제: 인하우스 앱의 카카오 로그인 서비스 상세 정보 조회

응답 예제: 비활성화 상태인 서비스에 대한 요청

FIND

요청 페이로드

응답 페이로드

요청 예제: 카카오 로그인 리다이렉트 URI 조회

응답 예제: 카카오 로그인 리다이렉트 URI 조회

응답 예제: 해당 상세 설정에 값이 없는 경우

UPDATE

요청 페이로드

응답 페이로드

요청 예제: 카카오 로그인 리다이렉트 URI 변경

응답 예제: 카카오 로그인 리다이렉트 URI 변경

DELETE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

도움이 되었나요?

내 애플리케이션: 서비스 설정

서비스

서비스: 상세