내 애플리케이션: 카카오싱크

신규 어드민 API 제공

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

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

주의

카카오싱크는 카카오비즈니스에서 사용 신청 및 검수를 완료한 앱만 사용할 수 있습니다. 카카오싱크를 참고합니다.

제목 태그

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

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

간편가입

요청

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

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

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

액션

이름	설명
HAS_PERMISSION	앱에 카카오싱크 사용 권한이 있는지 조회합니다.
IS_ENABLED	앱의 카카오싱크 간편가입 사용 여부를 조회합니다.
CHANGE_ENABLED	앱의 카카오싱크 간편가입 사용 설정을 변경합니다.

HAS_PERMISSION

앱에 카카오싱크 사용 권한이 있는지 조회합니다.

요청 처리 성공 시 응답은 payload에 앱의 카카오싱크 사용 권한 보유 여부를 포함합니다.

요청 페이로드

없음

응답 페이로드

앱의 카카오싱크 사용 권한 보유 여부
- true: 권한 있음
- false: 권한 없음

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp" \
  -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": "HAS_PERMISSION"
    }'

응답 예제

// HTTP/2 200
true

IS_ENABLED

앱의 카카오싱크 간편가입 사용 여부를 조회합니다.

요청 처리 성공 시 응답은 payload에 카카오싱크 간편가입 사용 여부를 포함합니다.

요청 페이로드

없음

응답 페이로드

앱의 카카오싱크 간편가입 사용 여부
- true: 사용
- false: 사용 안함

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp" \
  -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": "IS_ENABLED"
    }'

응답 예제

// HTTP/2 200
true

CHANGE_ENABLED

앱의 카카오싱크 간편가입 사용 설정을 변경합니다.

payload 하위의 enabled에 카카오싱크 간편가입 사용 여부를 전달합니다.

요청 처리 성공 시 응답은 payload에 변경된 카카오싱크 간편가입 사용 여부를 포함합니다.

요청 페이로드

이름	타입	설명	필수
enabled	`Boolean`	카카오싱크 간편가입 사용 여부 `true`: 사용 `false`: 사용 안함	O

응답 페이로드

앱의 카카오싱크 간편가입 사용 여부
- true: 사용
- false: 사용 안함

요청 예제

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

응답 예제

// HTTP/2 200
true

서비스 약관

요청

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

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

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

액션

이름	설명
FIND_ALL	서비스 약관 목록과 만 14세 이상 연령 동의 설정을 조회합니다.
CREATE Internal	서비스 약관 또는 만 14세 이상 연령 동의를 추가합니다.
CREATE_ALL	서비스 약관과 만 14세 이상 연령 동의를 추가합니다.
CREATE_SERVICE_TERMS	서비스 약관을 추가합니다.
CREATE_UNDER_AGE14	만 14세 이상 연령 동의를 사용하도록 설정합니다.
UPDATE_ALL_SEQUENCE	서비스 약관, 만 14세 이상 연령 동의의 노출 순서를 변경합니다.
DEACTIVATE_ALL	모든 서비스 약관, 만 14세 이상 연령 동의를 비활성화합니다.
DELETE_ALL	모든 서비스 약관, 만 14세 이상 연령 동의를 삭제합니다.

FIND_ALL

서비스 약관 목록과 만 14세 이상 연령 동의 설정을 조회합니다.

payload 하위의 status에 활성화 여부 조회 조건을 지정할 수 있습니다.

요청 처리 성공 시 응답은 payload에 서비스 약관 목록, 만 14세 이상 연령 동의 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
status	`String`	서비스 약관 활성화 여부, 아래 중 하나 `ACTIVATE`: 활성화 `DEACTIVATED`: 비활성화	X

응답 페이로드

ServiceTerms 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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
[
  {
    "id": 8872,
    "app_id": 977072,
    "sequence": 0,
    "title_ko": "테스트 약관",
    "title_en": "테스트 약관",
    "type": "SYNC",
    "tag": "term01",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-01T03:46:58Z",
    "updated_at": "2022-11-01T03:47:02Z"
  }
  // ...
]

CREATE
Internal

서비스 약관 또는 만 14세 이상 연령 동의를 추가합니다. 만 14세 이상 연령 동의 추가는 CREATE_ALL 또는 CREATE_UNDER_AGE14 사용을 권장합니다.

payload 하위의 파라미터로 추가할 서비스 약관 설정을 전달합니다. 서비스 약관의 각 항목 값은 지정된 규칙을 준수해야 합니다.

요청 처리 성공 시 응답은 payload에 추가된 서비스 약관 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
url	`String`	상세 URL	X
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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": {
            "sequence": 0,
            "title_ko": "테스트 약관3",
            "title_en": "테스트 약관3",
            "tag": "term03",
            "required": true,
            "url": "https://developers.kakao.com/terms",
            "status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8875,
  "app_id": 977072,
  "sequence": 0,
  "title_ko": "테스트 약관3",
  "title_en": "테스트 약관3",
  "type": "SYNC",
  "tag": "term03",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-01T08:12:11Z",
  "updated_at": "2022-11-01T08:12:11Z"
}

CREATE_ALL

서비스 약관과 만 14세 이상 연령 동의를 추가합니다.

payload 하위의 service_terms에 추가할 서비스 약관 정보 목록을 전달합니다. 만 14세 이상 연령 동의 추가 항목은 age_14 파라미터로 추가 요청합니다.

요청 처리 성공 시 응답은 payload에 추가된 서비스 약관 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
service_terms	`JSON[]`	서비스 약관 정보	O
age_14	`JSON`	만 14세 이상 확인 문구	X

payload.service_terms

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
url	`String`	상세 URL	X
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

payload.age_14

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
tag	`String`	태그(Tag)	O
required	`Boolean`	필수 서비스 약관 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
title_ja	`String`	일본어 제목 사용 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 満１４歳以上です。)	X
title_zh	`String`	중국어(간체) 제목 사용 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 14岁及以上)	X
title_zh_tw	`String`	중국어(번체) 제목 사용 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 年滿14歲)	X

응답 페이로드

ServiceTerms 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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_ALL",
        "payload": {
            "service_terms": [
                {
                    "sequence": 0,
                    "title_ko": "테스트약관1",
                    "title_en": "TEST1",
                    "tag": "term01",
                    "required": true,
                    "url": "https://developers.kakao.com/terms",
                    "status": "ACTIVE"
                },
                {
                    "sequence": 0,
                    "title_ko": "테스트약관2",
                    "title_en": "TEST2",
                    "tag": "term02",
                    "required": true,
                    "url": "https://developers.kakao.com/terms",
                    "status": "ACTIVE"
                }
            ],
            "age_14": {
                "sequence": 100,
                "tag": "term_age"
            }
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 8886,
    "app_id": 977072,
    "sequence": 0,
    "title_ko": "테스트약관1",
    "title_en": "TEST1",
    "type": "SYNC",
    "tag": "term01",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-01T10:17:46Z",
    "updated_at": "2022-11-01T10:17:46Z"
  },
  {
    "id": 8887,
    "app_id": 977071,
    "sequence": 1,
    "title_ko": "테스트약관2",
    "title_en": "TEST2",
    "type": "SYNC",
    "tag": "term02",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-01T10:17:46Z",
    "updated_at": "2022-11-01T10:17:46Z"
  },
  {
    "id": 8888,
    "app_id": 977071,
    "sequence": 100,
    "title_ko": "만 14세 이상입니다.",
    "title_en": "14 years old and older.",
    "type": "SYNC",
    "tag": "term_age",
    "required": false,
    "status": "ACTIVE",
    "created_at": "2022-11-01T10:17:46Z",
    "updated_at": "2022-11-01T10:17:46Z"
  }
]

CREATE_SERVICE_TERMS

서비스 약관을 추가합니다.

payload 하위의 파라미터로 추가할 서비스 약관 설정을 전달합니다.

요청 처리 성공 시 응답은 payload에 추가된 서비스 약관 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
url	`String`	상세 URL	X
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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_SERVICE_TERMS",
        "payload": {
            "sequence": 0,
            "title_ko": "테스트약관1",
            "title_en": "TEST1",
            "tag": "term01",
            "required": true,
            "url": "https://alpha-developers.kakao.com/terms",
            "status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8907,
  "app_id": 977072,
  "sequence": 0,
  "title_ko": "테스트약관1",
  "title_en": "TEST1",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-02T04:55:50Z",
  "updated_at": "2022-11-02T04:55:50Z"
}

CREATE_UNDER_AGE14

만 14세 이상 연령 동의를 사용하도록 설정합니다. 만 14세 이상 연령 동의는 하나만 설정할 수 있습니다.

payload 하위의 파라미터로 만 14세 이상 연령 동의에 적용할 설정을 전달합니다. 만 14세 이상 연령 동의는 국문과 영문을 기본 지원하고, 이 외 언어 지원 여부는 요청 시 지정할 수 있습니다.

요청 처리 성공 시 응답은 payload에 만 14세 이상 연령 동의 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
tag	`String`	태그(Tag)	O
required	`Boolean`	필수 서비스 약관 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
title_ja	`String`	일본어 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 満１４歳以上です。)	X
title_zh	`String`	중국어(간체) 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 14岁及以上)	X
title_zh_tw	`String`	중국어(번체) 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 年滿14歲)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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_UNDER_AGE14",
        "payload": {
            "sequence": 100,
            "tag": "term_age",
            "required": true
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8910,
  "app_id": 977072,
  "sequence": 100,
  "title_ko": "만 14세 이상입니다.",
  "title_en": "14 years old and older.",
  "type": "SYNC",
  "tag": "term_age",
  "required": true,
  "status": "ACTIVE",
  "created_at": "2022-11-02T05:30:59Z",
  "updated_at": "2022-11-02T05:30:59Z"
}

UPDATE_ALL_SEQUENCE

서비스 약관, 만 14세 이상 연령 동의의 노출 순서를 변경합니다.

payload 하위의 sequence에 각 서비스 약관의 ID와 노출 순서를 JSON 객체에 담아 전달합니다. 각 JSON 객체 내 키는 서비스 약관 ID, 값은 노출 순서로 지정합니다.

요청 처리 성공 시 응답은 payload에 노출 순서 변경 후의 서비스 약관 목록, 만 14세 이상 연령 동의 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`JSON`	서비스 약관 ID와 노출 순서 (예: `"sequence": {"8912": 1,"8913": 0}`)	O

응답 페이로드

ServiceTerms 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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_ALL_SEQUENCE",
        "payload": {
            "sequence": {
                "8912": 0,
                "8913": 1
            }
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 8912,
    "app_id": 977072,
    "sequence": 0,
    "title_ko": "테스트 약관1",
    "title_en": "Test1",
    "type": "SYNC",
    "tag": "term01",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-02T05:43:43Z",
    "updated_at": "2022-11-02T07:16:36Z"
  },
  {
    "id": 8913,
    "app_id": 977072,
    "sequence": 1,
    "title_ko": "테스트 약관2",
    "title_en": "Test2",
    "type": "SYNC",
    "tag": "term02",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-02T05:44:19Z",
    "updated_at": "2022-11-02T07:16:36Z"
  }
]

DEACTIVATE_ALL

모든 서비스 약관, 만 14세 이상 연령 동의를 비활성화합니다.

요청 처리 성공 시 응답은 payload에 비활성화한 서비스 약관 목록, 만 14세 이상 연령 동의 설정을 포함합니다.

요청 페이로드

없음

응답 페이로드

ServiceTerms 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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": "DEACTIVATE_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 8911,
    "app_id": 977072,
    "sequence": 100,
    "title_ko": "만 14세 이상입니다.",
    "title_en": "14 years old and older.",
    "type": "SYNC",
    "tag": "term_age",
    "required": true,
    "status": "DEACTIVATED",
    "created_at": "2022-11-02T05:32:21Z",
    "updated_at": "2022-11-02T07:19:44Z",
    "deactivated_at": "2022-11-02T07:19:45Z"
  }
  // ...
]

DELETE_ALL

모든 서비스 약관, 만 14세 이상 연령 동의를 삭제합니다.

요청 처리 성공 시 응답은 payload에 삭제된 서비스 약관 목록, 만 14세 이상 연령 동의 설정을 포함합니다.

요청 페이로드

없음

응답 페이로드

ServiceTerms 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms" \
  -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_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 8912,
    "app_id": 977072,
    "sequence": 0,
    "title_ko": "테스트 약관1",
    "title_en": "Test1",
    "type": "SYNC",
    "tag": "term01",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-02T05:43:43Z",
    "updated_at": "2022-11-02T07:22:38Z",
    "deactivated_at": "2022-11-02T07:19:45Z"
  },
  {
    "id": 8913,
    "app_id": 977072,
    "sequence": 1,
    "title_ko": "테스트 약관2",
    "title_en": "Test2",
    "type": "SYNC",
    "tag": "term02",
    "required": true,
    "url": "https://developers.kakao.com/terms",
    "status": "ACTIVE",
    "created_at": "2022-11-02T05:44:19Z",
    "updated_at": "2022-11-02T07:22:40Z",
    "deactivated_at": "2022-11-02T07:19:45Z"
  },
  {
    "id": 8911,
    "app_id": 977072,
    "sequence": 100,
    "title_ko": "만 14세 이상입니다.",
    "title_en": "14 years old and older.",
    "type": "SYNC",
    "tag": "term_age",
    "required": true,
    "status": "ACTIVE",
    "created_at": "2022-11-02T05:32:21Z",
    "updated_at": "2022-11-02T07:22:43Z",
    "deactivated_at": "2022-11-02T07:19:45Z"
  }
]

개별 서비스 약관 관리

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.
:service_terms_id 부분에 서비스 약관 ID를 입력해야 합니다.

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

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

액션

이름	설명
FIND	특정 서비스 약관 정보를 조회합니다.
UPDATE Internal	특정 서비스 약관 또는 만 14세 이상 연령 동의 설정을 변경합니다.
UPDATE_SERVICE_TERMS	특정 서비스 약관 설정을 변경합니다.
UPDATE_UNDER_AGE14	만 14세 이상 연령 동의 설정을 변경합니다.
UPDATE_STATUS	특정 서비스 약관의 활성화 여부를 변경합니다.
UPDATE_SEQUENCE	특정 서비스 약관의 노출 순서를 변경합니다.
ACTIVE	특정 서비스 약관을 활성화 상태로 변경합니다.
DEACTIVATE	특정 서비스 약관을 비활성화 상태로 변경합니다.
DELETE	특정 서비스 약관을 삭제합니다.

FIND

특정 서비스 약관 정보를 조회합니다.

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

요청 페이로드

없음

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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": 8935,
  "app_id": 977072,
  "sequence": 0,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "DEACTIVATED",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T07:53:06Z"
}

UPDATE
Internal

특정 서비스 약관 또는 만 14세 이상 연령 동의 설정을 변경합니다. 만 14세 이상 연령 동의 설정 변경은 UPDATE_UNDER_AGE14 사용을 권장합니다.

payload 하위의 파라미터로 변경할 서비스 약관 설정을 전달합니다.

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

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
url	`String`	상세 URL	X
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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": {
            "sequence": 2,
            "title_ko": "테스트 약관 변경",
            "title_en": "Test Update",
            "tag": "term02",
            "required": true,
            "url": "https://developers.kakao.com/terms",
            "status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 2,
  "title_ko": "테스트 약관 변경",
  "title_en": "Test Update",
  "type": "SYNC",
  "tag": "term02",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T08:04:34Z"
}

UPDATE_SERVICE_TERMS

특정 서비스 약관 설정을 변경합니다. 이 액션은 서비스 약관이 아닌 만 14세 이상 연령 동의 대상으로는 동작하지 않습니다.

payload 하위의 파라미터로 변경할 서비스 약관 설정을 전달합니다.

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

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
title_ko	`String`	국문 제목	O
title_en	`String`	영문 제목	O
title_ja	`String`	일본어 제목	X
title_zh	`String`	중국어(간체) 제목	X
title_zh_tw	`String`	중국어(번체) 제목	X
tag	`String`	태그(Tag)	O
url	`String`	상세 URL	X
required	`Boolean`	동의 필수 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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_SERVICE_TERMS",
        "payload": {
            "sequence": 1,
            "title_ko": "테스트 약관 변경",
            "title_en": "Test Update",
            "tag": "term01",
            "required": true,
            "url": "https://developers.kakao.com/terms",
            "status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 1,
  "title_ko": "테스트 약관 변경",
  "title_en": "Test Update",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T08:09:17Z"
}

UPDATE_UNDER_AGE14

만 14세 이상 연령 동의 설정을 변경합니다. 이 액션은 만 14세 이상 연령 동의가 아닌 서비스 약관 대상으로는 동작하지 않습니다.

payload 하위의 파라미터로 변경할 설정을 전달합니다.

요청 처리 성공 시 응답은 payload에 변경된 만 14세 이상 연령 동의 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	노출 순서(최소: 0, 최대: 100)	O
tag	`String`	태그(Tag)	O
required	`Boolean`	필수 서비스 약관 여부 `true`: 필수 `false`: 선택 (기본값: `false`)	X
title_ja	`String`	일본어 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 満１４歳以上です。)	X
title_zh	`String`	중국어(간체) 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 14岁及以上)	X
title_zh_tw	`String`	중국어(번체) 제목 지원 여부 `true`: 지원 `false`: 미지원 (출력되는 문구: 年滿14歲)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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_UNDER_AGE14",
        "payload": {
            "sequence": 0,
            "tag": "term_age",
            "required": true
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8936,
  "app_id": 977072,
  "sequence": 0,
  "title_ko": "만 14세 이상입니다.",
  "title_en": "14 years old and older.",
  "type": "SYNC",
  "tag": "term_age",
  "required": true,
  "status": "ACTIVE",
  "created_at": "2022-11-02T07:53:10Z",
  "updated_at": "2022-11-02T08:17:10Z"
}

UPDATE_STATUS

특정 서비스 약관의 활성화 여부를 변경합니다. 이 액션은 서비스 약관과 만 14세 이상 연령 동의 모두 변경 가능합니다.

payload 하위의 status에 활성화 여부를 전달합니다.

요청 처리 성공 시 응답은 payload에 활성화 여부 변경 후 서비스 약관 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
status	`String`	활성화 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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_STATUS",
        "payload": {
            "status": "DEACTIVATED"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 2,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term02",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "DEACTIVATED",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T08:24:23Z",
  "deactivated_at": "2022-11-02T08:24:23Z"
}

UPDATE_SEQUENCE

특정 서비스 약관의 노출 순서를 변경합니다. 이 액션은 서비스 약관과 만 14세 이상 연령 동의 모두 변경 가능합니다.

payload 하위의 sequence에 변경할 노출 순서 값을 전달합니다.

요청 처리 성공 시 응답은 payload에 노출 순서 변경 후 서비스 약관 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
sequence	`Int`	서비스 약관 노출 순서	O

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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_SEQUENCE",
        "payload": {
            "sequence": 100
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 100,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T09:34:43Z",
  "deactivated_at": "2022-11-02T08:24:23Z"
}

ACTIVE

특정 서비스 약관을 활성화 상태로 변경합니다. 이 액션은 서비스 약관과 만 14세 이상 연령 동의 모두 변경 가능합니다.

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

요청 페이로드

없음

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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": "ACTIVE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 1,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "ACTIVE",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T09:37:27Z",
  "deactivated_at": "2022-11-02T08:24:23Z"
}

DEACTIVATE

특정 서비스 약관을 비활성화 상태로 변경합니다. 이 액션은 서비스 약관과 만 14세 이상 연령 동의 모두 변경 가능합니다.

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

요청 페이로드

없음

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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": "DEACTIVATE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 1,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "DEACTIVATED",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T09:45:19Z",
  "deactivated_at": "2022-11-02T09:45:20Z"
}

DELETE

특정 서비스 약관을 삭제합니다. 이 액션은 서비스 약관과 만 14세 이상 연령 동의 모두 삭제 가능합니다.

요청 처리 성공 시 응답은 payload에 삭제한 서비스 약관 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

ServiceTerms

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/easySignUp/serviceTerms/:service_terms_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": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 8935,
  "app_id": 977072,
  "sequence": 1,
  "title_ko": "테스트 약관",
  "title_en": "Test",
  "type": "SYNC",
  "tag": "term01",
  "required": true,
  "url": "https://developers.kakao.com/terms",
  "status": "DEACTIVATED",
  "created_at": "2022-11-02T07:53:06Z",
  "updated_at": "2022-11-02T09:45:59Z",
  "deactivated_at": "2022-11-02T09:46Z"
}

ECP 앱 관리

요청

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

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

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

액션

이름	설명
HAS_ACTIVE_ECP_APP	앱에 활성화(`ACTIVE`) 상태인 ECP 앱 설정이 있는지 조회합니다.
FIND_ALL	ECP 앱 설정 목록을 조회합니다.
FIND	특정 ECP 타입인 ECP 앱 설정을 조회합니다.
CREATE	ECP 앱 설정을 등록합니다.
UPDATE	ECP 앱 설정을 수정합니다.
UPDATE_STATUS	ECP 앱 상태를 수정합니다.
DELETE	ECP 앱 설정을 삭제합니다.

HAS_ACTIVE_ECP_APP

앱에 활성화(ACTIVE) 상태인 ECP 앱 설정이 있는지 조회합니다.

요청 처리 성공 시 응답은 ECP 앱 설정 존재 여부를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

활성화 상태인 ECP 앱 설정 존재 여부
- true: 있음
- false: 없음

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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": "HAS_ACTIVE_ECP_APP"
    }'

응답 예제

// HTTP/2 200
false

FIND_ALL

ECP 앱 설정 목록을 조회합니다. 각 앱은 여러 개의 ECP 앱 설정을 가질 수 있습니다.

요청 처리 성공 시 응답은 ECP 앱 설정 목록을 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

ECPApp[]

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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
[
  {
    "id": 52,
    "app_id": 977072,
    "ecp_type": "ETC",
    "last_updated_by": "ADMIN",
    "status": "ACTIVE",
    "created_at": "2023-03-14T02:34:36Z",
    "updated_at": "2023-03-14T02:34:43Z"
  }
]

FIND

특정 ECP 타입인 ECP 앱 설정을 조회합니다.

payload 하위의 파라미터로 조회할 ECP 타입을 지정합니다.

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

요청 페이로드

이름	타입	설명	필수
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O

응답 페이로드

ECPApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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": {
            "ecp_type": "ETC"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 52,
  "app_id": 977072,
  "ecp_type": "ETC",
  "last_updated_by": "ADMIN",
  "status": "ACTIVE",
  "created_at": "2023-03-14T02:34:36Z",
  "updated_at": "2023-03-14T02:34:43Z"
}

CREATE

ECP 앱 설정을 등록합니다.

payload 하위의 파라미터로 ECP 앱 설정을 전달합니다.

요청 처리 성공 시 응답은 등록된 ECP 앱 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O
ecp_key	`String`	호스팅사에서 쇼핑몰에 발급하는 식별자 카카오와 호스팅사의 카카오싱크 간편설정 팝업 연동을 위해 호스팅사에서 카카오로 전달	X
status	`Boolean`	ECP 앱 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X
comment	`String`	관리자 메모	X

응답 페이로드

ECPApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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": {
            "ecp_type": "WISA"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 53,
  "app_id": 977072,
  "ecp_type": "WISA",
  "last_updated_by": "ASSUMPTION",
  "status": "ACTIVE",
  "created_at": "2023-03-14T03:03:03Z",
  "updated_at": "2023-03-14T03:03:03Z"
}

UPDATE

ECP 앱 설정을 수정합니다. ECP 타입 변경 시에는 새로운 ECP 앱 설정을 등록합니다.

payload 하위의 파라미터로 수정할 ECP 앱 설정을 전달합니다.

요청 처리 성공 시 응답은 변경된 ECP 앱 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O
ecp_key	`String`	호스팅사에서 쇼핑몰에 발급하는 식별자 카카오와 호스팅사의 카카오싱크 간편설정 팝업 연동을 위해 호스팅사에서 카카오로 전달	X
status	`Boolean`	ECP 앱 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화 (기본값: `ACTIVE`)	X
comment	`String`	관리자 메모	X

응답 페이로드

ECPApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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": {
            "ecp_type": "SHOPBY",
            "status": "DEACTIVATED"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 56,
  "app_id": 977072,
  "ecp_type": "SHOPBY",
  "last_updated_by": "ASSUMPTION",
  "status": "DEACTIVATED",
  "created_at": "2023-03-14T03:23:15Z",
  "updated_at": "2023-03-14T03:23:15Z"
}

UPDATE_STATUS

ECP 앱 상태를 수정합니다.

payload 하위의 파라미터로 ECP 타입과 ECP 앱 활성화 상태를 전달합니다.

요청 처리 성공 시 응답은 변경된 ECP 앱 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O
status	`Boolean`	ECP 앱 상태 `ACTIVE`: 활성화 `DEACTIVATED`: 비활성화	O

응답 페이로드

ECPApp

요청 예제

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

응답 예제

// HTTP/2 200
{
  "id": 56,
  "app_id": 977072,
  "ecp_type": "SHOPBY",
  "last_updated_by": "ASSUMPTION",
  "status": "ACTIVE",
  "created_at": "2023-03-14T03:23:15Z",
  "updated_at": "2023-03-14T03:28:29Z"
}

DELETE

ECP 앱 설정을 삭제합니다.

payload 하위의 파라미터로 ECP 타입을 지정합니다.

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

요청 페이로드

이름	타입	설명	필수
ecp_type	`String`	ECP 타입, 아래 중 하나 `SHOPBY`: 샵바이 `WISA`: 위사 `FIRSTMALL`: 퍼스트몰 `GABIA`: 가비아 `CAFE24`: 카페24 `GODOMALL`: 고도몰 `SIXSHOP`: 식스샵 `MAKESHOP`: 메이크샵 `IMWEB`: 아임웹 `ETC`: 기타	O

응답 페이로드

ECPApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/ecpApp" \
  -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": {
            "ecp_type": "SHOPBY"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 56,
  "app_id": 977072,
  "ecp_type": "SHOPBY",
  "last_updated_by": "ASSUMPTION",
  "status": "DEACTIVATED",
  "created_at": "2023-03-14T03:23:15Z",
  "updated_at": "2023-03-14T03:28:52Z"
}

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

내 애플리케이션: 카카오싱크

제목 태그

간편가입

요청

액션

HAS_PERMISSION

요청 페이로드

응답 페이로드

요청 예제

응답 예제

IS_ENABLED

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CHANGE_ENABLED

요청 페이로드

응답 페이로드

요청 예제

응답 예제

서비스 약관

요청

액션

FIND_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CREATEInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CREATE_ALL

요청 페이로드

payload.service_terms

payload.age_14

응답 페이로드

요청 예제

응답 예제

CREATE_SERVICE_TERMS

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CREATE_UNDER_AGE14

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_ALL_SEQUENCE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

DEACTIVATE_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제

DELETE_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제

개별 서비스 약관 관리

요청

액션

CREATE
Internal

UPDATE
Internal