본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

관련사이트

사이드 메뉴

플랫폼 API

API 제공

전용 API

어드민 API

이 문서는 특정 서비스를 위한 REST API 사용 방법을 안내합니다.

메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/payment/statistics
공동체
https://kapi.kakao.com/v1/internal/payment/statistics
액세스 토큰
서비스 앱 어드민 키
권한사전 설정카카오 로그인동의항목
카카오페이 전용어드민 키
카카오 로그인 활성화
동의항목
필요: 연결필요: 금융데이터 분석 및 활용을 위한 데이터 제공

특정 사용자의 카카오 서비스별 결제 및 이용 통계 데이터를 조회합니다. 이 API는 지정된 사용자의 최근 90일 서비스별 결제 및 이용 정보를 기간 단위로 집계해 제공합니다. 제공하는 데이터의 상세 구성은 아래와 같습니다.

분류상세
집계 기간최근 7일
최근 30일
최근 90일
정보 종류이용 통계 정보: 접속 일수(visit_count)
결제 관련 통계 정보: 결제 횟수(payment_count), 결제 금액(payment_amount), 결제 일수(payment_days)
조회 대상 서비스이용 통계 정보: 이모티콘, 카카오 선물하기, 카카오맵, 다음 뉴스, 다음 검색
결제 관련 통계 정보: 이모티콘, 카카오 선물하기, 카카오쇼핑하기

원하는 인증 정보를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 사용자의 서비스별 결제 통계 데이터를 집계 기간, 종류별로 포함합니다. 값이 0인 필드는 응답에 포함되지 않으며, 모든 하위 필드의 값이 0인 상위 필드 또한 응답에 포함되지 않습니다.

알파, 샌드박스 페이즈(Phase)는 통계 데이터가 존재하지 않아, 실제 응답과 동일한 구조의 목업 데이터를 대신 제공합니다.

이름설명필수
AuthorizationAuthorization: Bearer ${ACCESS_TOKEN}
인증 방식, 액세스 토큰으로 인증 요청
O
이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
이름타입설명필수
target_idString결제 통계 데이터를 가져올 사용자 IDO
target_id_typeStringtarget_id 타입, 아래 중 하나
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
O
이름타입설명필수
idInteger회원번호O
account_idInteger카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한 보유
X
visit_countVisitCount서비스별 접속 일수X
payment_countPaymentCount서비스별 결제 횟수X
payment_amountPaymentAmount서비스별 결제 금액 합계X
payment_daysPaymentDays서비스별 결제 일수X
이름타입설명필수
last_7_daysServiceVisitInfo최근 7일 서비스별 접속 일수X
last_30_daysServiceVisitInfo최근 30일 서비스별 접속 일수X
last_90_daysServiceVisitInfo최근 90일 서비스별 접속 일수X
  • 뉴티아라 데이터 기준으로 집계된 서비스별 접속 일수
이름타입설명필수
emoticonInteger해당 기간 이모티콘 접속 일수X
giftInteger해당 기간 카카오 선물하기 접속 일수X
mapInteger해당 기간 카카오맵 접속 일수X
이름타입설명필수
last_7_daysServicePaymentInfo최근 7일 서비스별 결제 금액 합계X
last_30_daysServicePaymentInfo최근 30일 서비스별 결제 금액 합계X
last_90_daysServicePaymentInfo최근 90일 서비스별 결제 금액 합계X
이름타입설명필수
last_7_daysServicePaymentInfo최근 7일 서비스별 결제 횟수X
last_30_daysServicePaymentInfo최근 30일 서비스별 결제 횟수X
last_90_daysServicePaymentInfo최근 90일 서비스별 결제 횟수X
이름타입설명필수
last_7_daysServicePaymentInfo최근 7일 서비스별 결제 일수X
last_30_daysServicePaymentInfo최근 30일 서비스별 결제 일수X
last_90_daysServicePaymentInfo최근 90일 서비스별 결제 일수X
이름타입설명필수
emoticonInteger해당 기간 이모티콘 통계
각 상위 필드에 해당하는 데이터 제공
(예: 상위 필드가 payment_days인 경우, 이모티콘 결제 일수)
X
giftInteger해당 기간 카카오 선물하기 통계
각 상위 필드에 해당하는 데이터 제공
(예: 상위 필드가 payment_amount인 경우, 카카오 선물하기 결제 금액 합계)
X
talk_storeInteger해당 기간 카카오쇼핑하기 통계
각 상위 필드에 해당하는 데이터 제공
(예: 상위 필드가 payment_count인 경우, 카카오쇼핑하기 결제 횟수)
X
  • 파라미터: 없음
curl -v -G GET "http://kapi.kakao.com/v1/internal/payment/statistics" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
curl -v -G GET "http://kapi.kakao.com/v1/internal/payment/statistics" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=2137162" \
-d "target_id_type=user_id"
// HTTP/1.1 200 OK
{
"id": 1376016924429759243,
"account_id": 2137162,
"visit_count": {
"last_90_days": {
"gift": 6,
"map": 3
}
},
"payment_count": {
"last_7_days": {
"gift": 1
},
"last_30_days": {
"gift": 3,
"talk_store": 1
},
"last_90_days": {
"gift": 10,
"talk_store": 5
}
},
"payment_amount": {
"last_7_days": {
"gift": 24900
},
"last_30_days": {
"gift": 49500,
"talk_store": 16000
},
"last_90_days": {
"gift": 155300,
"talk_store": 96670
}
},
"payment_days": {
"last_7_days": {
"gift": 1
},
"last_30_days": {
"gift": 2,
"talk_store": 1
},
"last_90_days": {
"gift": 8,
"talk_store": 4
}
}
}
  • 사용자가 필요한 동의항목 중 [최근 90일의 카카오 서비스 이용 통계 정보(서비스별 접속 일수)]만 동의한 경우
  • 사용자 동의가 필요한 payment_days, payment_amount, payment_count 필드를 제외하고 응답 제공
// HTTP/1.1 200 OK
{
"id": 1376016924429759243,
"account_id": 2137162,
"visit_count": {
"last_90_days": {
"gift": 6,
"map": 3
}
}
}
// HTTP/1.1 400 Bad Request
{
"msg": "NotRegisteredUserException",
"code": -101
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v2/user/gift_purchase_history
공동체
https://kapi.kakao.com/v2/user/gift_purchase_history
서비스 앱 어드민 키
데이터동의항목
카카오 선물하기 서비스 최근 12개월 이용 정보:
상품유형, 구매 횟수/목적/시간/금액, 환불/취소 횟수, 지불방법, 선물 수신/발신자 수

중요: 카카오쇼핑 앱과 연결(가입)된 사용자인 경우에만 데이터 제공
카카오 선물하기 서비스의 최근 12개월 이용정보(상품유형, 구매 횟수/목적/시간/금액, 환불/취소 횟수, 지불방법, 선물 수신/발신자 수 등)

사용자의 최근 12개월간 카카오 선물하기 서비스 이용 내역을 조회합니다. 제공하는 데이터는 위 필요한 동의항목 표를 참고합니다.

서비스 앱 어드민키를 헤더에 담아 GET으로 요청합니다. 이 API는 사용 협의 시 등록한 카카오뱅크의 전용망을 이용해 HTTPS로 요청해야 합니다.

요청 성공 시 사용자의 최근 12개월 카카오 선물하기 서비스 이용 내역 데이터를 받습니다. 이 API는 요청 시점에서 사용자가 각 조회 대상 서비스를 이용해 해당 서비스 앱과 연결(가입)되어 있고, 서비스별 필요한 동의항목에 동의한 경우에만 데이터를 제공합니다. 사용자가 이용하지 않는 서비스이거나 제공에 동의하지 않은 데이터는 응답에 포함되지 않습니다.

2022년 10월 14일부터 카카오 서비스 이용 내역 조회 API가 카카오 선물하기 서비스 이용 내역 조회, 카카오T 서비스 이용 내역 조회로 나뉘어 제공됩니다. 기존 버전 API인 /v1/account/service_purchase_history의 정보는 별도 문서에서 확인할 수 있습니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
이름타입설명필수
target_idString카카오 서비스 이용 내역을 조회할 사용자의 카카오계정 IDO
target_id_typeStringtarget_id 타입
카카오계정 ID(account_id)로 고정

참고: ID 종류
O
이름타입설명필수
ACCOUNT_IDString카카오 사용자의 카카오계정 IDO
DATA_AGREEInteger카카오 선물하기 데이터 동의여부
  • 0: 동의하지 않음
  • 1: 동의함
O
KKC000006Integer최근 6개월 구매건수X
KKC000007Integer최근 12개월 구매건수X
KKC000008Integer최근 6개월 구매건수 모바일교환권(카페)X
KKC000030Integer최근 6개월 00:00~03:59(KST) 구매건수X
KKC000031Integer최근 6개월 12:00~15:59(KST) 구매건수X
KKC000032Integer최근 6개월 20:00~23:59(KST) 구매건수X
KKC000033Integer최근 6개월 08:00~11:59(KST) 구매건수X
KKC000035Integer최근 6개월 나에게 선물한 건수X
KKC000036Integer최근 12개월 나에게 선물한 건수X
KKC000038Integer최근 6개월 남에게 선물한 건수X
KKC000039Integer최근 12개월 남에게 선물한 건수X
KKC000063Integer최근 6개월 선물한 사람 수X
KKC000064Integer최근 12개월 선물한 사람 수X
KKC000066Integer최근 6개월 나에게 선물한 사람 수X
KKC000067Integer최근 12개월 나에게 선물한 사람 수X
KKC000069Integer최근 6개월 결제금액X
KKC000070Integer최근 12개월 결제금액X
KKC000071Integer최근 6개월 최대 결제금액X
KKC000072Integer최근 6개월 최소 결제금액X
KKC000073Integer최근 6개월 결제금액, 모바일교환권(카페)X
KKC000095Integer최근 6개월 구매건수, 01: 휴대전화 결제X
KKC000096Integer최근 6개월 구매건수, 02: 신용카드X
KKC000097Integer최근 6개월 구매건수, 07: 카드 간편결제X
KKC000098Integer최근 6개월 구매건수, 09: 카카오머니 결제X
KKC000099Integer최근 6개월 구매건수, 12: 카카오 포인트X
KKC000108Integer최근 6개월 취소건수X
KKC000109Integer최근 12개월 취소건수X
KKC000116Integer최근 6개월 환불건수X
KKC000117Integer최근 12개월 환불건수X
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 카카오계정 ID(account_id)
curl -v -G GET "https://kapi.kakao.com/v2/user/gift_purchase_history" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=${ACCOUNT_ID}" \
-d "target_id_type=account_id"
// HTTP/1.1 200 OK
{
"ACCOUNT_ID": 7234535,
"DATA_AGREE": 1,
"KKC000006": 4,
"KKC000007": 22,
"KKC000008": null,
"KKC000030": 2,
"KKC000031": 1,
"KKC000032": null,
"KKC000033": 1,
"KKC000035": 3,
"KKC000036": 6,
"KKC000038": 1,
"KKC000039": 16,
"KKC000063": 1,
"KKC000064": 15,
"KKC000066": 4,
"KKC000067": 14,
"KKC000069": 116800,
"KKC000070": 802600,
"KKC000071": 44000,
"KKC000072": 17900,
"KKC000073": null,
"KKC000095": null,
"KKC000096": null,
"KKC000097": 3,
"KKC000098": 1,
"KKC000099": null,
"KKC000108": 1,
"KKC000109": 2,
"KKC000116": 7,
"KKC000117": 11
}
  • 카카오 선물하기 미사용자인 경우
  • 사용자가 필요한 동의항목에 동의하지 않은 경우
// HTTP/1.1 200 OK
{
"ACCOUNT_ID": 7072935,
"DATA_AGREE": 0,
"KKC000006": null,
"KKC000007": null,
"KKC000008": null,
"KKC000030": null,
"KKC000031": null,
"KKC000032": null,
"KKC000033": null,
"KKC000035": null,
"KKC000036": null,
"KKC000038": null,
"KKC000039": null,
"KKC000063": null,
"KKC000064": null,
"KKC000066": null,
"KKC000067": null,
"KKC000069": null,
"KKC000070": null,
"KKC000071": null,
"KKC000072": null,
"KKC000073": null,
"KKC000095": null,
"KKC000096": null,
"KKC000097": null,
"KKC000098": null,
"KKC000099": null,
"KKC000108": null,
"KKC000109": null,
"KKC000116": null,
"KKC000117": null
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v2/user/taxi_purchase_history
공동체
https://kapi.kakao.com/v2/user/taxi_purchase_history
서비스 앱 어드민 키
데이터동의항목
카카오 T 최근 6개월 탑승 정보:
카카오 T 가입 일시(연결 시각), 택시 서비스 유형별 탑승 횟수, 택시 서비스 유형별 예상 요금 합계, 미수금 존재 여부

중요: 카카오 T 앱과 연결(가입)된 사용자인 경우에만 데이터 제공
카카오택시 최근 6개월 탑승정보(탑승횟수, 예상금액 등)

사용자의 최근 6개월간 카카오T 서비스 이용 내역을 조회합니다. 제공하는 데이터는 위 필요한 동의항목 표를 참고합니다.

서비스 앱 어드민키를 헤더에 담아 GET으로 요청합니다. 이 API는 사용 협의 시 등록한 카카오뱅크의 전용망을 이용해 HTTPS로 요청해야 합니다.

요청 성공 시 사용자의 최근 6개월 카카오T 서비스 이용 내역 데이터를 받습니다. 이 API는 요청 시점에서 사용자가 각 조회 대상 서비스를 이용해 해당 서비스 앱과 연결(가입)되어 있고, 서비스별 필요한 동의항목에 동의한 경우에만 데이터를 제공합니다. 사용자가 이용하지 않는 서비스이거나 제공에 동의하지 않은 데이터는 응답에 포함되지 않습니다.

2022년 10월 14일부터 카카오 서비스 이용 내역 조회 API가 카카오 선물하기 서비스 이용 내역 조회, 카카오T 서비스 이용 내역 조회로 나뉘어 제공됩니다. 기존 버전 API인 /v1/account/service_purchase_history의 정보는 별도 문서에서 확인할 수 있습니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
이름타입설명필수
target_idString카카오 서비스 이용 내역을 조회할 사용자의 카카오계정 IDO
target_id_typeStringtarget_id 타입
카카오계정 ID(account_id)로 고정

참고: ID 종류
O
이름타입설명필수
ACCOUNT_IDString카카오 사용자의 카카오계정 IDO
DATA_AGREEInteger택시 데이터 동의 여부
  • 0: 동의하지 않음
  • 1: 동의함
O
CREATED_ATInteger제공된 데이터의 배치(Batch) 성공 시점, 유닉스 타임스탬프 형식X
MOB000001Integer최근 6개월 내 택시 또는 대리 이용실적 유무
  • 0: 이용실적 없음
  • 1: 이용실적 있음
X
MOB000002Integer가입일자, 유닉스 타임스탬프 형식X
MOB000007Integer6개월 택시 B2C 벤티서비스 결제발생건수(운임)X
MOB000008Integer6개월 택시 B2C 스마트호출서비스 결제발생건수(운임)X
MOB000010Integer6개월 택시 B2C 06:00~11:00(KST) 결제발생건수(운임)X
MOB000011Integer6개월 택시 B2C 12:00~17:00(KST) 결제발생건수(운임)X
MOB000012Integer6개월 택시 B2C 18:00~23:00(KST) 결제발생건수(운임)X
MOB000013Integer6개월 택시 B2C 00:00~05:00(KST) 결제발생건수(운임)X
MOB000025Integer6개월 택시 B2C 전체서비스 총 운임X
MOB000027Integer6개월 택시 B2C 모범서비스 총 운임X
MOB000028Integer6개월 택시 B2C 블랙서비스 총 운임X
MOB000032Integer6개월 택시 B2C 06:00~11:00(KST) 총 운임X
MOB000033Integer6개월 택시 B2C 12:00~17:00(KST) 총 운임X
MOB000034Integer6개월 택시 B2C 18:00~23:00(KST) 총 운임X
MOB000035Integer6개월 택시 B2C 00:00~05:00(KST) 총 운임X
MOB000037Integer6개월 택시 B2C 주말 총 운임X
MOB000050Integer6개월 택시 B2C 결제취소건수X
MOB000056Integer6개월 택시 B2C 전체서비스 운행완료건수X
MOB000060Integer6개월 택시 B2C 벤티서비스 운행완료건수X
MOB000063Integer6개월 택시 B2C 06:00~11:00(KST) 운행완료건수X
MOB000065Integer6개월 택시 B2C 18:00~23:00(KST) 운행완료건수X
MOB000066Integer6개월 택시 B2C 00:00~05:00(KST) 운행완료건수X
MOB000067Integer6개월 택시 B2C 주중 운행완료건수X
MOB000068Integer6개월 택시 B2C 주말 운행완료건수X
MOB000078Integer3개월 택시 B2C 전체서비스 결제발생건수(운임)X
MOB000089Integer3개월 택시 B2C 주중 결제발생건수(운임)X
MOB000090Integer3개월 택시 B2C 주말 결제발생건수(운임)X
MOB000100Integer3개월 택시 B2C 전체서비스 총운임X
MOB000101Integer3개월 택시 B2C 일반서비스 총운임X
MOB000104Integer3개월 택시 B2C 벤티서비스 총운임X
MOB000107Integer3개월 택시 B2C 06:00~11:00(KST) 총운임X
MOB000108Integer3개월 택시 B2C 12:00~17:00(KST) 총운임X
MOB000109Integer3개월 택시 B2C 18:00~23:00(KST) 총운임X
MOB000110Integer3개월 택시 B2C 00:00~05:00(KST) 총운임X
MOB000111Integer3개월 택시 B2C 주중 총운임X
MOB000112Integer3개월 택시 B2C 주말 총운임X
MOB000131Integer3개월 택시 B2C 전체서비스 운행완료건수X
MOB000132Integer3개월 택시 B2C 일반서비스 운행완료건수X
MOB000138Integer3개월 택시 B2C 06:00~11:00(KST) 운행완료건수X
MOB000139Integer3개월 택시 B2C 12:00~17:00(KST) 운행완료건수X
MOB000140Integer3개월 택시 B2C 18:00~23:00(KST) 운행완료건수X
MOB000141Integer3개월 택시 B2C 00:00~05:00(KST) 운행완료건수X
MOB000142Integer3개월 택시 B2C 주중 운행완료건수X
MOB000143Integer3개월 택시 B2C 주말 운행완료건수X
  • 파라미터
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 카카오계정 ID(account_id)
curl -v -G GET "https://kapi.kakao.com/v2/user/taxi_purchase_history" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "target_id=${ACCOUNT_ID}" \
-d "target_id_type=account_id"
// HTTP/1.1 200 OK
{
"ACCOUNT_ID": 7077525,
"DATA_AGREE": 1,
"CREATED_AT": 1663769137275,
"MOB000001": 1,
"MOB000002": 1583107200000,
"MOB000007": 2,
"MOB000008": 0,
"MOB000010": 23,
"MOB000011": 46,
"MOB000012": 29,
"MOB000013": 2,
"MOB000025": 863000,
"MOB000027": 0,
"MOB000028": 15500,
"MOB000032": 323000,
"MOB000033": 251400,
"MOB000034": 259400,
"MOB000035": 29200,
"MOB000037": 194600,
"MOB000050": 0,
"MOB000056": 60,
"MOB000060": 2,
"MOB000063": 17,
"MOB000065": 16,
"MOB000066": 1,
"MOB000067": 46,
"MOB000068": 14,
"MOB000078": 58,
"MOB000089": 42,
"MOB000090": 16,
"MOB000100": 569500,
"MOB000101": 245900,
"MOB000104": 0,
"MOB000107": 197000,
"MOB000108": 113100,
"MOB000109": 230200,
"MOB000110": 29200,
"MOB000111": 668400,
"MOB000112": 194600,
"MOB000131": 35,
"MOB000132": 12,
"MOB000138": 9,
"MOB000139": 12,
"MOB000140": 13,
"MOB000141": 1,
"MOB000142": 26,
"MOB000143": 9
}
  • 사용자가 카카오T에 연결(가입)되지 않은 경우
  • 사용자가 필요한 동의항목에 동의하지 않은 경우
// HTTP/1.1 200 OK
{
"ACCOUNT_ID": 7079533,
"DATA_AGREE": 0,
"CREATED_AT": null,
"MOB000001": null,
"MOB000002": null,
"MOB000007": null,
"MOB000008": null,
"MOB000010": null,
"MOB000011": null,
"MOB000012": null,
"MOB000013": null,
"MOB000025": null,
"MOB000027": null,
"MOB000028": null,
"MOB000032": null,
"MOB000033": null,
"MOB000034": null,
"MOB000035": null,
"MOB000037": null,
"MOB000050": null,
"MOB000056": null,
"MOB000060": null,
"MOB000063": null,
"MOB000065": null,
"MOB000066": null,
"MOB000067": null,
"MOB000068": null,
"MOB000078": null,
"MOB000089": null,
"MOB000090": null,
"MOB000100": null,
"MOB000101": null,
"MOB000104": null,
"MOB000107": null,
"MOB000108": null,
"MOB000109": null,
"MOB000110": null,
"MOB000111": null,
"MOB000112": null,
"MOB000131": null,
"MOB000132": null,
"MOB000138": null,
"MOB000139": null,
"MOB000140": null,
"MOB000141": null,
"MOB000142": null,
"MOB000143": null
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/account/business/deletable
공동체
https://kapi.kakao.com/v1/internal/account/business/deletable
서비스 앱 어드민 키

카카오비즈니스 통합 계정인 카카오계정의 카카오디벨로퍼스 탈퇴 가능 여부를 확인합니다. 이 API는 카카오비즈니스에서 카카오디벨로퍼스 탈퇴 가능 여부를 확인하기 위해 사용합니다. 카카오비즈니스 통합 계정인 카카오계정의 경우, 카카오비즈니스 통합 서비스 약관을 사용하는 서비스 중 하나라도 탈퇴 불가능하다면 카카오비즈니스에서 탈퇴할 수 없습니다. 카카오 API 플랫폼의 개발자 웹사이트인 카카오디벨로퍼스 또한 카카오비즈니스 통합 서비스 약관 사용 서비스이며, 카카오디벨로퍼스 앱을 소유하고 있는 카카오계정은 카카오비즈니스 탈퇴가 불가능합니다. (참고: 카카오디벨로퍼스 탈퇴 가능 여부 조회)

헤더에 카카오계정 시스템 앱의 어드민 키를 담아 GET으로 요청합니다. 요청 시 카카오계정 ID를 전달해야 합니다.

요청 성공 시 응답은 카카오비즈니스 통합 계정인 카카오계정의 탈퇴 가능 여부와 안내를 포함합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}
인증 방식, 서비스 앱 어드민 키로 인증 요청
O
이름타입설명필수
account_idInteger카카오계정 IDO
localeString응답 언어 지정, 기본값인 KO로 고정X
이름타입설명필수
canWithdrawBoolean카카오비즈니스 통합 계정인 카카오계정의 탈퇴 가능 여부
  • true: 가능
  • false: 불가
O
reasonsReason[]canWithdraw 값이 false인 경우, 탈퇴 불가 사유 목록X
이름타입설명필수
serviceTypeString서비스 타입, DEVELOPERS(카카오디벨로퍼스)로 고정X
causeStringcanWithdraw 값이 false인 경우에만 응답에 포함
탈퇴 불가 사유
X
actionStringcanWithdraw 값이 false인 경우에만 응답에 포함
탈퇴 불가 사유 해소 방법
X
urlStringcanWithdraw 값이 false인 경우에만 응답에 포함
탈퇴 불가 사유 해소를 위한 서비스 페이지 바로가기 URL
X
  • 파라미터
    • 서비스 앱 ID(target_app_id)
    • 카카오계정 ID(account_id)
curl -v -G GET "http://kapi.kakao.com/v1/internal/account/business/deletable" \
-H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
-d "account_id=2350171"
// HTTP/1.1 200 OK
{
"canWithdraw": false,
"reasons": [
{
"serviceType": "DEVELOPERS",
"cause": "카카오 개발자 웹사이트에서 탈퇴가 필요합니다.",
"action": "카카오 개발자 웹사이트로 이동해 직접 탈퇴해 주세요.",
"url": "https://alpha-developers.kakao.com/user/profile"
}
]
}
메서드URL인증 방식
GET카카오
http://kapi.kakao.com/v1/internal/ecp_app
공동체
https://kapi.kakao.com/v1/internal/ecp_app
위임

쇼핑몰 앱의 카카오싱크 설정과 호스팅사 정보를 조회합니다. 쇼핑몰 앱 정보만 조회하려면 앱 정보 조회 API를 참고합니다.

헤더에 플랫폼 앱 어드민 키를 담아 GET으로 요청합니다. 쇼핑몰 앱의 REST API 키 또는 JavaScript 키와 호스팅사 앱 어드민 키를 쿼리 파라미터로 함께 전달해야 합니다.

요청 성공 시 응답은 쇼핑몰 앱과 해당 앱이 속한 호스팅사 정보가 포함된 JSON 객체입니다. 요청 실패 시 응답 코드로 원인을 확인합니다.

이름설명필수
AuthorizationAuthorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}
인증 방식, 플랫폼 앱 어드민 키로 인증 요청
서비스 앱의 권한을 플랫폼 앱이 위임받아 요청하는 방식으로 내부 API 요청 시 사용 가능
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
이름타입설명필수
target_app_keyString쇼핑몰 앱의 REST API 키 또는 JavaScript 키O
target_ecp_app_keyString호스팅사의 앱 어드민 키O
이름타입설명
app_infoAppInfo쇼핑몰 앱 정보
ecp_infoEcpInfo쇼핑몰 앱이 속한 호스팅 사 정보
이름타입설명
ecp_typeString호스팅사
MAKESHOP, SIXSHOP, CAFE24
ecp_keyString호스팅사에서 관리하는 해당 서비스 키
카카오싱크 간편설정 팝업에서 조회
ecp_onDatetime쇼핑몰 앱이 카카오싱크 간편설정 팝업에서 마지막으로 수정 완료된 시각
app_idInteger개발자 웹사이트에 등록된 쇼핑몰 앱의 ID
app_nameString서비스명
companyString서비스 업체명
biz_registration_numString사업자등록번호
website_domainsString[]웹 도메인
JavaScript 키로 카카오톡 공유 사용 시 리퍼러(referrer) 체크
redirect_uriString[]카카오 인증 완료 후 이동할 리다이렉트 URI
app_keysAppKey쇼핑몰 앱의 앱키
app_scopesAppScope[]해당 앱이 사용 중인 동의항목 리스트
service_termsServiceTerm[]간편가입 설정 (tag, title_ko, title_en, order)
kakao_talk_channelsKakaoTalkChannel[]동의창에 보이는 플친 정보 (public_id, name, uuid)
이름타입설명
JAVASCRIPT_KEYStringJavaScript 키
REST_API_KEYStringREST API 키
NATIVE_APP_KEYString네이티브 앱 키
이름타입설명
idString동의항목 ID
displayString동의항목을 나타내는 한국어 이름
levelString동의항목 설정 상태, 아래 중 하나
  • required: 필수 항목
  • optional: 선택 항목
  • lazy: 이용 중 동의
collectingBoolean[카카오 계정으로 정보 수집 후 제공] 설정이 켜져 있는지 여부
이름타입설명
tagString서비스 약관의 tag
title_koString서비스 약관의 한글 title
title_enString서비스 약관의 영문 title
orderInteger서비스 약관이 보여지는 순서
이름타입설명
channel_public_idString카카오톡 채널의 public id
channel_nameString카카오톡 채널의 이름
channel_uuidString카카오톡 채널의 검색용 id
이름타입설명
idInteger앱 id
nameString앱 이름
companyString앱 회사명
ecp_typeString호스팅사, 접두사 ECP_ 포함
ECP_MAKESHOP, ECP_SIXSHOP, ECP_CAFE24
biz_registration_numberString호스팅사의 사업자 등록번호
curl -v -G GET "http://kapi.kakao.com/v1/internal/ecp_app" \
-H "Authorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}" \
-H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \
-d "target_app_key=${TARGET_APP_KEY}" \
-d "target_ecp_app_key=${ECP_APP_ADMIN_KEY}"
{
"ecp_type": "MAKESHOP",
"ecp_key": "ecp_test_key_12233543645",
"ecp_on": "2020-08-14T09:06:02Z",
"app_id": 833225,
"app_name": "쇼핑몰 이름",
"company": "쇼핑몰 회사명",
"biz_registration_num": "111-12-12345",
"website_domains": ["http://xxx.co.kr", "https://xxx.co.kr", "http://m.xxx.co.kr", "https://m.xxx.co.kr"],
"redirect_uris": ["http://xxx.co.kr/list/API/login_kakao_sync.html", "https://xxx.co.kr/list/API/login_kakao_sync.html", "http://m.xxx.co.kr/list/API/login_kakao_sync.html", "https://m.xxx.co.kr/list/API/login_kakao_sync.html"],
"app_keys": {
"JAVASCRIPT_KEY": "${JAVASCRIPT_KEY}",
"REST_API_KEY": "${REST_API_KEY}",
"NATIVE_APP_KEY": "${NATIVE_APP_KEY}"
},
"app_scopes": [
{
"id": "profile",
"display": "프로필 정보(닉네임/프로필 사진)",
"level": "required",
"collecting": false
},
{
"id": "legal_name",
"display": "본인확인정보(이름)",
"level": "required",
"collecting": false
},
{
"id": "account_email",
"display": "카카오계정(이메일)",
"level": "required",
"collecting": false
},
{
"id": "account_ci",
"display": "CI(연계정보)",
"level": "required",
"collecting": false
},
{
"id": "phone_number",
"display": "카카오계정(전화번호)",
"level": "required",
"collecting": false
},
{
"id": "birthday",
"display": "생일",
"level": "optional",
"collecting": false
}
],
"service_terms": [
{
"tag": "age_2020_0218",
"title_ko": "만 14세 이상입니다.",
"title_en": "14 years old and older.",
"required": true,
"order": 10
},
{
"tag": "marketing_2020_02181",
"title_ko": "마케팅 활용 동의",
"title_en": "marketing",
"required": true,
"order": 1
},
{
"tag": "optional_20200616",
"title_ko": "선택 동의 서비스 약관",
"title_en": "optional",
"required": false,
"order": 4
},
{
"tag": "service_2020_0218",
"title_ko": "서비스 약관 동의",
"title_en": "Service terms",
"required": true,
"order": 1
}
],
"kakao_talk_channels": [
{
"public_id": "_Xxxxxx",
"name": "채널이름",
"uuid": "@채널1"
}
],
"ecp_info": {
"id": 57532,
"name": "호스팅사 앱 이름",
"company": "호스팅사 이름",
"ecp_type": "ECP_MAKESHOP",
"biz_registration_num": "${호스팅사 사업자 등록번호}"
}
}
{ "code": -401, "msg": "appKeyType is NATIVE_APP_KEY. but expected ADMIN_KEY" }
{ "code": -401, "msg": "no authentication key!" }
{ "code": -401, "msg": "wrong appKey(${APP_KEY}) format" }
{ "code": -5, "msg": "permission denied" }
메서드URL인증 방식
POST카카오
http://kapi.kakao.com/v1/internal/user/plugin/complete
공동체
https://kapi.kakao.com/v1/internal/user/plugin/complete
위임

싱크 플러그인으로 회원 가입 절차를 완료 처리합니다. 이 API는 공통 플러그인에서 싱크 플러그인의 회원 가입 절차에 사용하며, 카카오싱크 간편가입을 이용 중인 서비스 앱 대상으로만 요청할 수 있습니다. 이 API 호출까지의 과정은 아래와 같습니다. (참고: 개발 문서)

  1. 카카오싱크 서비스가 싱크 플러그인으로 사용자의 회원 가입 처리를 완료합니다.
  2. 카카오싱크 서비스는 싱크 플러그인의 Redirect Continue URL로 302 리다이렉트(Redirect)해 회원 가입이 완료되었음을 알립니다.
  3. 공통 플러그인은 이 API를 호출해 싱크 플러그인으로 회원 가입 절차를 완료 처리합니다.

헤더에 플랫폼 앱 어드민 키를 담아 POST로 요청합니다. 요청 시 싱크 플러그인을 이용한 카카오싱크 서비스 앱의 ID, 회원 가입한 사용자의 회원번호를 전달해야 합니다.

요청 성공 시, 카카오 API 플랫폼은 대상 서비스 앱의 설정과 사용자의 연결(가입) 상태를 확인하고 아래 동작을 수행합니다.

  • 서비스 앱과 사용자가 연결됨
    • 응답의 result 값을 true로 반환
    • 사용자 프로퍼티에 싱크 플러그인으로 연결되었다는 정보 기록
  • 서비스 앱과 사용자가 연결되지 않음
    • NotRegisteredUserException(-101) 에러 발생
  • 서비스 앱 설정이 API 사용 조건을 만족하지 않음
    • 카카오 로그인, 카카오싱크 간편가입 및 서비스 약관을 사용하고 있지 않은 앱 대상으로 요청한 경우
    • 에러(-3) 및 사유 반환
이름설명필수
AuthorizationAuthorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}
인증 방식, 플랫폼 앱 어드민 키로 인증 요청
서비스 앱의 권한을 플랫폼 앱이 위임받아 요청하는 방식으로 내부 API 요청 시 사용 가능
서비스 구분을 위해 서비스 앱의 앱 ID, 앱 키, 토큰 중 하나 파라미터로 전달 필요
O
Content-TypeContent-Type: application/x-www-form-urlencoded;charset=utf-8
요청 데이터 타입
O
  • 요청 대상 사용자를 어떤 파라미터로 지정하는지에 따라 필수 파라미터 구성이 달라집니다.
    • 서비스 앱 키: target_app_key, target_id, target_id_type
    • 서비스 앱 ID: target_app_id, target_id, target_id_type
    • 액세스 토큰: target_access_token
이름타입설명필수
target_app_keyString싱크 플러그인을 이용한 서비스 앱의 키O(Optional)
target_app_idString싱크 플러그인을 이용한 서비스 앱의 IDO(Optional)
target_access_tokenString싱크 플러그인으로 가입한 사용자의 액세스 토큰 값O(Optional)
target_idString싱크 플러그인으로 가입한 사용자 IDO(Optional)
target_id_typeStringtarget_id 타입, 아래 중 하나
  • user_id: 회원번호
  • account_id: 카카오계정 ID
  • talk_id: 카카오톡 회원번호
O(Optional)
이름타입설명필수
app_idInteger싱크 플러그인을 이용한 서비스 앱 IDO
account_idString싱크 플러그인으로 가입한 사용자의 카카오계정 ID

제공 조건: 카카오계정 ID 응답 권한 보유
X
user_idLong싱크 플러그인으로 가입한 사용자의 회원번호O
resultBoolean싱크 플러그인 사용자의 회원 가입 완료 여부
서비스 앱과 사용자가 연결된 경우에만 true 값 반환
O
  • 파라미터
    • 서비스 앱 키(target_app_key)
    • 사용자 ID(target_id)
    • 사용자 ID 타입(target_id_type): 회원번호(user_id)
curl -v -X POST "http://kapi.kakao.com/v1/internal/user/plugin/complete" \
-H "Authorization: KakaoAK ${DELEGATOR_APP_ADMIN_KEY}" \
-d "target_app_key=${SERVICE_APP_KEY}" \
-d "target_id_type=user_id" \
-d "target_id=1376016924429266116"
// HTTP/1.1 200 OK
{
"app_id": 938123,
"account_id": "12345",
"user_id": 1376016924429266116,
"result": true
}
// HTTP/1.1 400 Bad Request
{
"msg": "NotRegisteredUserException",
"code": -101
}
// HTTP/1.1 403 Forbidden
{
"msg": "SERVICE_TERMS_SUPPORTED permission off - appId=1134530",
"code": -3
}

도움이 되었나요?