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

kakao developers

관련사이트

사이드 메뉴

플랫폼 API

API 제공

전용 API

어드민 API

이 문서는 자주 묻는 질문과 답변을 제공합니다.

앱의 기본 정보인 앱 이름, 앱 아이콘, 회사명은 실제 서비스 사용자에게 노출되는 항목이므로 반드시 등록해야 합니다. 앱 아이콘 디자인이 완료되기 전이라면 임시 아이콘이라도 등록해야 합니다. 자세한 안내는 을 참고합니다.

ID 종류을 참고합니다.

동의항목은 앱 관리 페이지의 [카카오 로그인] > [동의항목]에서 설정합니다. 동의항목, 동의항목을 참고합니다.

자동 연결 또는 수동 연결은 앱 관리 페이지의 [카카오 로그인] > [고급] > [로그인 시 앱 자동 연결]에서 설정합니다. 수동 연결을 참고합니다.

수동 연결을 사용하는 서비스는 일반적으로 아래 순서에 따라 서비스 가입과 연결을 처리합니다.

  1. 카카오 로그인 완료
    • 액세스 토큰 및 리프레시 토큰 발급
    • 로그인 완료 시, 사용자의 연결 상태는 연결대기(PREREGISTERED)
  2. 액세스 토큰 정보 조회를 요청해 액세스 토큰 유효성 검증 및 회원번호(id) 확인
  3. 서비스의 가입 절차 제공
    • 회원번호 필요 시, 2단계에서 확인한 회원번호 사용
  4. 서비스의 가입 절차 완료 후 수동 연결 API 호출
    • 수동 연결 API 요청 성공 시, 사용자의 연결 상태는 연결(REGISTERED)
  5. 사용자 정보 조회로 사용자 정보를 요청하거나, 이 외 필요한 카카오 API를 호출해 서비스 가입 완료 처리

수동 연결, 지원 범위를 함께 참고합니다.

  1. 수동 연결을 참고해 수동 연결 설정
  2. 카카오 로그인 완료 시 액세스 토큰으로 앱 연결 이력 조회를 호출해 탈퇴 이력 확인
  3. 탈퇴 이력 확인 후 재가입 가능 여부에 따라 분기 처리
    • 재가입 가능한 경우: 서비스 가입 절차 제공 및 완료 후 수동 연결 API 호출
    • 재가입 불가능한 경우: 서비스 로그아웃 처리 및 연결 해제 호출

연령인증을 참고합니다.

토큰 만료 시간은 알파(Alpha), 샌드박스(Sandbox) 페이즈(Phase)에서만 테스트 목적으로 변경 가능합니다. 토큰 만료 시간의 기본값과 변경 방법은 토큰 만료 시간에서 확인할 수 있습니다.

사용자 정보 조회 API는 응답 캐시 기능이 적용되어 있습니다. 이로 인해 아래 카카오계정 정보에 대한 변경이 실시간으로 반영되지 않을 수 있습니다.

  • 카카오계정의 카카오톡 연결 상태 변경
    • 카카오톡 탈퇴, 카카오톡 가입 등으로 talk_user_id 변경, 카카오톡 전화번호 변경 시 사용자 정보 조회 API 에 바로 반영되지 않음
  • 카카오계정 정보 변경
    • 카카오계정 대표 이메일 변경, 카카오계정 프로필사진, 닉네임, 성별, 생년월일 등의 카카오계정 프로필 정보 변경 시 사용자 정보 조회 API 에 바로 반영되지 않음

캐시에 저장된 정보를 응답받은 경우 응답 헤더에 X-Response-Cache: Hit 항목이 포함됩니다. 예를 들어, 아래와 같이 사용자 정보 조회를 요청했을 때,

curl -v -G GET 'http://kapi.kakao.com/v2/internal/user/me' \
-H 'Authorization: Bearer {access_token}'

캐시에 저장된 정보가 응답된 경우라면, 아래와 같이 응답 헤더에 X-Response-Cache: Hit 항목이 포함됩니다.

// HTTP/1.1 200 OK
// ...
// X-Response-Cache: Hit
// Content-Type: application/json;charset=UTF-8
// Content-Length: 1140
{
"id": 12346
// ...
}

개발 시 테스트 과정에서 변경된 정보를 바로 확인해야 하는 경우, 요청 헤더에 X-Response-Cache-Control: no-cache 항목을 포함해 캐시 미적용 데이터를 응답 받을 수 있습니다. 아래 예제를 참고합니다.

curl -v -G GET 'http://kapi.kakao.com/v2/internal/user/me' \
-H 'Authorization: Bearer ${access_token}' \
-H 'X-Response-Cache-Control: no-cache'
주의

캐시 미적용 데이터 요청 헤더(X-Response-Cache-Control: no-cache)는 개발과정에서 디버깅 용도로만 사용할 것을 권장합니다.

카카오톡 프로필 정보 우선순위를 참고합니다.

카카오톡 친구 목록 조회 API는 응답 캐시 기능이 적용되어 있습니다. 적용된 응답 캐시에 대한 자세한 내용은 친구 API: 응답 캐시를 참고합니다.

기능 소개를 참고합니다.

연결 해제 웹훅은 아래와 같은 경우 웹훅으로 서비스에 사용자의 연결 해제 사실을 알려주는 기능입니다.

  • 사용자가 연결된 서비스 관리와 같은 서비스 외부에서 연결 해제를 요청한 경우
  • 카카오계정이 탈퇴될 경우

앱에서 연결 해제 API를 직접 호출한 경우에는 웹훅을 지원하지 않습니다. 탈퇴와 연결 해제를 함께 참고합니다.

사내망에서만 호출할 수 있는 내부 API와 일부 API를 제외한 대부분의 카카오 API를 Kakao SDK로 사용할 수 있습니다. 각 카카오 API의 Kakao SDK 지원 여부는 지원 범위에서 확인할 수 있습니다.

JavaScript SDK(Kakao SDK for JavaScript)는 Kakao.API.request() 함수로 일부 REST API 호출을 지원합니다. Kakao.API.request() 함수가 지원하는 REST API와 url 값은 아래 표를 참고합니다.

urlAPI
/v1/user/access_token_info액세스 토큰 정보 조회*
/v1/user/logout로그아웃*
/v1/user/signup수동 연결*
/v1/user/unlink연결 해제
/v2/user/scopes동의항목 동의 내역 조회
/v2/user/revoke/scopes동의항목 동의 철회
/v2/user/service_terms서비스 약관 동의 내역 조회
/v2/user/revoke/service_terms서비스 약관 동의 철회
* JavaScript SDK를 사용한 클라이언트에서의 호출을 권장하지 않음
urlAPI
/v2/user/me사용자 정보 조회
/v1/user/update_profile사용자 프로퍼티 저장
/v1/user/shipping_address배송지 조회
urlAPI
/v1/api/talk/profile카카오톡 프로필 조회
/v1/api/talk/friends카카오톡 친구 목록 조회
/v1/friends인하우스 앱: 카카오톡 친구 목록 조회*
* JavaScript SDK를 사용한 클라이언트에서의 호출을 권장하지 않음
urlAPI
/v2/api/talk/memo/default/send나에게 기본 템플릿으로 메시지 발송
/v2/api/talk/memo/send나에게 사용자 정의 템플릿으로 메시지 발송
/v2/api/talk/memo/scrap/send나에게 스크랩 메시지 발송
/v1/api/talk/friends/message/default/send기본 템플릿으로 메시지 발송
/v1/api/talk/friends/message/send사용자 정의 템플릿으로 메시지 발송
/v1/api/talk/friends/message/scrap/send스크랩 메시지 발송
urlAPI
/v1/api/talk/channels카카오톡 채널 관계 조회

도움이 되었나요?