API 목록

카카오싱크 간편가입

카카오 플랫폼에서는

카카오 API에서 사용자 인증을 위한 code 값과 함께 Redirect Continue URL을 서비스의 카카오싱크 플러그인 전용 Redirect URI로 리다이렉트(Redirect)합니다. 서비스에서 로그인 Redirect URI로 전달된 code와 continue 파라미터 값을 전달 받습니다. 서비스에서 전달 받은 code 값으로 액세스 토큰(Access Token)을 요청합니다. 서비스에서 전달 받은 액세스 토큰을 사용하여 사용자 정보를 요청합니다. 서비스에서 전달받은 액세스 토큰을 사용하여 사용자의 동의한 약관을 확인합니다. 서비스에서 해당 카카오계정 사용자 정보로 서비스 회원 가입 처리를 하거나, 정보 식별 결과 기존 회원이라면 카카오 로그인으로도 기존 정보로 서비스를 이용할 수 있도록 회원 정보 맵핑 및 연동 처리를 합니다. 서비스에서 사용자 등록을 완료한 후, Redirect URI로 전달된 continue의 값인 Redirect Continue URL로 302 리다이렉트합니다. 카카오에서 서비스의 응답을 전달 받아 싱크 플러그인을 통한 로그인을 완료 처리합니다.

카카오싱크 플러그인의 동의화면

카카오 로그인 사용 설정이 켜져(ON) 있지 않으면 카카오싱크를 통한 간편 로그인 및 가입도 불가능하므로 반드시 사용하도록 설정합니다.

위와 같이 카카오싱크는 사용자가 한 번의 동의 과정만으로도 서비스의 신규 회원으로 가입할 수 있도록 지원합니다. 또한 카카오싱크 간편가입 사용자는 가입 이후에도 ID 및 비밀번호를 입력하는 대신 카카오 로그인을 통해 서비스에 손쉽게 로그인할 수 있습니다. 서비스는 카카오가 제공하는 API를 통해 회원가입에 필요한 계정 입력 방식의 로그인 과정이나 사용자 정보 입력 절차 등을 최대한 간소화하여 보다 손쉽게 모객을 할 수 있습니다.

모두 완료된 것입니다.

동의 항목을 설정했더라도 사용자가 동의하지 않은 동의 항목의 사용자 정보를 요청한 경우에는 에러 응답이 반환되거나 데이터를 제공하지 않습니다.

🅐 상태 변경: 활성화 시 카카오 로그인 동의 화면에 노출, 비활성화 시 카카오 로그인 동의 화면에 비노출

🅐 약관 제목: 한국어, 영어 모두 입력 🅑 약관 URL: 약관 내용을 확인할 수 있는 웹 페이지 URL 입력 🅒 약관 조건: 필수 동의 항목 또는 선택 동의 항목 중 선택 🅓 태그: 각 서비스 약관을 가리키는 고유값 입력 서비스 약관 등록 시 지켜야 할 규칙은 아래와 같습니다. 약관 제목 한국어 약관 제목은 한글, 영문, 숫자, 공백, 키보드에서 직접 입력 가능한 특수문자만 지원(최대 45자) 영어 약관 제목은 영문, 숫자, 공백, 키보드에서 직접 입력 가능한 특수문자만 지원(최대 100자) 영문 약관이 없더라도 영어 약관 제목은 영어로 입력, 영어 약관 제목은 사용자 기기의 언어 설정이 영어일 때 사용됨 약관 URL 약관 URL은 필수 입력 선택 약관에 한해 URL 생략 가능 약관 조건 가입 시 반드시 동의해야 하는 서비스 약관은 [필수 동의 항목]으로 설정 서비스 제공 범위에 따라 사용자가 추가 동의할 수 있는 서비스 약관은 [선택 동의 항목]으로 설정 태그 다음 카카오 API 요청 시 태그 사용, 실제 서비스 개발 시 사용 가능한 값으로 입력 동의한 약관 확인하기: 사용자의 약관별 동의 여부 확인 약관 선택해 동의 받기: 사용자에게 특정 서비스 약관 동의 요청 영문, 숫자, 하이픈(-), 언더스코어(_)만 입력 가능 ${KEYWORD}_${DATE}, ${KEYWORD}_${ORDER} 등 형식 권장(예: terms_20220701, terms_01)

🅐 제목: 약관의 제목을 입력합니다. (한국어와 영문 모두 필수)
  한국어 약관 제목은 한글, 영문, 숫자, 공백, 키보드에서 직접 입력 가능한 특수문자만 지원(최대 45자)
  영어 약관 제목은 영문, 숫자, 공백, 키보드에서 직접 입력 가능한 특수문자만 지원(최대 100자)
  영문 약관이 없더라도 영어 약관 제목은 영어로 입력, 영어 약관 제목은 사용자 기기의 언어 설정이 영어일 때 사용됨
🅑 URL: 약관 내용을 확인할 수 있는 웹 페이지 URL을 입력합니다. ('약관 조건'이 [필수 동의 항목]인 경우 필수)
🅒 조건: 서비스 약관의 조건을 선택합니다.
  [필수 동의 항목]: 가입 시 반드시 동의해야 하는 서비스 약관
  [선택 동의 항목]: 서비스 제공 범위에 따라 사용자가 추가 동의할 수 있는 서비스 약관
🅓 TAG: 서비스 약관을 가리키는 고유값입니다. (필수)
  아래 카카오 API 요청 시 태그 사용
    동의한 약관 확인하기
    약관 선택해 동의 받기
  실제 서비스 개발 시 사용 가능한 값으로 입력
  영문, 숫자, 하이픈(-), 언더스코어(_)만 입력 가능
  ${KEYWORD}_${DATE}, ${KEYWORD}_${ORDER} 등 형식 권장(예: terms_20220701, terms_01)

문의 사항은 고객센터로 문의합니다.

추가 항목 동의 받기 서비스 운영 중 추가 설정한 동의 항목이거나, 사용자가 카카오 로그인 및 서비스 가입 시 동의하지 않은 동의 항목이라도 추가 항목 동의 받기로 동의받을 수 있습니다.

사용자가 앱과 연결된 상태여야 사용할 수 있습니다. 사용자가 서비스를 더 이상 이용하지 않아 탈퇴 처리하거나 카카오 로그인 연동을 해제할 경우, 서비스는 앱과 사용자의 연결을 끊어야 합니다. 서비스는 연결 끊기를 요청해 서비스의 앱과 사용자의 연결을 끊을 수 있습니다. 카카오 플랫폼은 연결 끊기 요청을 받으면 사용자가 서비스 이용을 위해 동의했던 동의 항목의 동의를 철회하고 로그아웃시킵니다.

서비스는 서비스 ID 및 비밀번호를 입력받고 검증하는 과정을 직접 구현하지 않고도

이와 달리 iOS SDK v2는 명시적인 초기화를 필요로 합니다. 앱 실행 후 초기화 이후에 각 API를 호출하도록 구현해야 합니다.

예를 들어 네이티브 앱 키가 "123456789"라면 [URL Schemes]에 "kakao123456789"를 입력합니다.

이 설정은 iOS SDK를 통해 카카오 API를 사용하려면 필수입니다.

를 통해

를 통해

KakaoSDK

KakaoSdk

기본적으로 설치됩니다.

모듈 설정 시 설정한 모듈들과 함께

유틸리티 성격의 기능들을

설치 및 설정 후 Android SDK를 사용하기 위해서는 가장 먼저 네이티브 앱 키로 초기화를 해야 합니다.

이 설정은 카카오 API를 통한 HTTP 요청이 올바르게 완료되도록 해 줍니다.

[이메일(account_email)] 항목

앱 정보: REST API 요청을 보낼 대상 테스트 앱을 선택합니다. 예제인 [developers-sample]이 기본 설정돼 있으며, 앱 이름 옆의 목록 버튼을 눌러 사용자가 직접 등록한 앱으로 변경 가능합니다.

tag

🅒

🅑

🅐

🅐 카카오싱크를 적용할 쇼핑몰 정보를 선택하고 다음 단계로 이동합니다. 🅑 [신규 앱 생성하기] 버튼을 눌러 신규 앱을 생성할 수도 있습니다. 다만, 꼭 필요한 경우에만 신규 앱 생성을 권장합니다. 계정당 오너 권한의 앱은 최대 10개까지만 운영할 수 있습니다.

먼저 현재 서비스에서 카카오 API를 호출하기 위해 사용하는 앱 키가 어느 플랫폼의 앱 키(App key)인지 확인합니다. 서비스에 사용된 앱 키 값을 확인합니다. Kakao SDK 초기화를 하는 Kakao.init()에 사용된 앱 키를 확인하거나, 카카오 로그인 요청 URL의 client_id 값과 같이 카카오 API를 호출할 때 사용된 앱 키를 확인합니다. 카카오디벨로퍼스의 [내 애플리케이션] > [앱 키] 메뉴에서 사용 중인 앱 키가 어느 플랫폼의 앱 키인지 확인합니다. 사용 중인 앱 키 값이 REST API 키와 일치한다면 REST API 키, JavaScript 키와 일치한다면 JavaScript 키를 사용하여 개발해야 합니다.

카카오모먼트를 통해 카카오싱크 회원 여부를 타깃팅하여 디스플레이 광고를 할 수 있습니다.

사용자는 카카오톡 앱으로 QR 코드를 스캔할 수 있지만, 스마트폰의 기본 카메라나 기타 다른 앱을 통해 스캔하기도 합니다. 이 때, 사용자가 사용하는 스캐너 종류와 상관 없이 카카오톡 클라이언트를 실행해 계정 정보 입력의 번거로움을 줄이고,

이동되는

매장 점원에게 핸드폰 번호를 불러주거나 입력하는 대신, 사용자가 QR 코드를 스캔하고 바코드를 찍어 직접 적립 처리를 할 수 있습니다.

설정한다면

오프라인에서 회원 모집하기

API를 통해 자동으로 파일을 업로드하려면, 위에서 안내한 카카오톡 채널 고객 관리 API를 참고하여 개발합니다.

서비스 가입 여부에 따른 분기 처리 지원

사용자가 어떤 약관들에 동의하고 로그인했는지 확인앱에 등록된 서비스 이용 약관은 각각 태그(Tag) 값 존재동의한 약관 확인하기를 사용해 사용자가 동의한 약관 태그 확인 가능사용자별 응답과 전체 이용약관을 비교해 추가로 동의받을 항목이 있는지 확인필요시 약관 선택해 동의 받기를 호출하거나, 서비스에서 자체적으로 약관 동의 절차를 거치도록 구현

예외 처리를 위해 사용자의 로그인 취소 등 주요 에러

연결 끊기 후 서비스의 탈퇴 처리 서비스의 탈퇴 처리는 연결 끊기 후 직접 구현해야 합니다. 해당 기능은 사용자와 개발자 웹사이트 앱의 연결을 해제하지만, 서비스 탈퇴에 영향을 주지 않습니다.

주의 서비스의 로그아웃은 직접 구현해야 합니다. Kakao.Auth.logout() 함수는 로그인 시 발급받은 토큰을 만료시키지만, 카카오계정의 로그아웃이나 서비스의 로그아웃에 영향을 주지 않습니다.

카카오톡에서 자동 로그인은

사용자가 동의하지 않은 동의 항목에 대한 추가 동의

서비스 서버가 발급받은 액세스 토큰으로 사용자 정보 가져오기를 요청해 사용자의 회원번호 및 정보를 조회하여 서비스 회원인지 확인합니다. 서비스 클라이언트에서 토큰 할당 후 사용자 정보 가져오기를 요청할 수도 있습니다. 서비스 회원 정보 확인 결과에 따라 서비스 로그인 또는 회원 가입 과정을 진행합니다. 이 외 서비스에서 필요한 로그인 절차를 수행한 후, 카카오 로그인한 사용자의 서비스 로그인 처리를 완료합니다.

사용자가 동의하지 않은 항목의 사용자 정보는

요청 성공 시, 요청 시 전달된

페이로드(Payload) 값이 이 API의 응답이

어드민 키는 앱의 꼭 서버에서 호출할 때만 사용해야 합니다.

어떤 약관들에

사용자가 동의한 동의 항목의 상세 정보 목록을 조회합니다.

사용자가 동의한 항목에 대해 동의를 철회합니다.

사용자가 동의하지 않으면

동의 항목 설정을

처리하여야

후속 조치를 취하도록 합니다.

동의 화면은 사용자와 앱이 처음 연결될 때만 나타납니다. 사용자가 이미 동의 화면에서 서비스 이용에 필요한 동의 항목에 동의 완료한 경우, 해당 사용자의 카카오 로그인 시에는 동의 화면이 나타나지 않고 즉시 인가 코드가 발급됩니다. 사용자와 앱이 연결된 이후 다시 동의 화면을 통해 특정 동의 항목에 대한 사용자 동의를 요청하려면 추가 항목 동의 받기로 동의 화면을 호출할 수 있습니다. 서비스 가입 과정이 올바르게 완료되지 않아 다시 동의 화면을 호출해야 할 경우에는 연결 끊기 후 다시 인가 코드 받기를 요청합니다.

카카오 로그인 동의 화면을 호출하고, 사용자 동의를 거쳐 인가 코드를 발급합니다.

서비스 서버가 발급받은 액세스 토큰으로 사용자 정보 가져오기를 요청해 사용자의 회원번호 및 정보를 조회하여 서비스 회원인지 확인합니다. 서비스 회원 정보 확인 결과에 따라 서비스 로그인 또는 회원 가입 과정을 진행합니다. 이 외 서비스에서 필요한 로그인 절차를 수행한 후, 카카오 로그인한 사용자의 서비스 로그인 처리를 완료합니다.

Redirect URI는 다음 규칙에 맞게 등록해야 합니다. Redirect URI는 최대 10개까지 등록할 수 있습니다. Redirect URI는 HTTP 및 HTTPS 프로토콜, 80, 443 포트를 허용합니다. Redirect URI는 HTTP, HTTPS 프로토콜을 구분하므로 각각 등록해야 합니다.

카카오 로그인을 사용하려면 [내 애플리케이션] > [카카오 로그인]에서 [활성화 설정]의 [상태]를 [ON]으로 설정해야 합니다. [활성화 설정]의 [상태]가 [OFF]인 경우, 카카오 로그인 요청 시 KOE004 에러가 발생합니다.

🅐 카카오 로그인 활성화 설정, 🅒 Redirect URI 등록은 반드시 설정해야 합니다. 🅑 OpenID Connect 활성화 설정은 필요 시 사용합니다.

🅐 카카오 로그인 활성화 설정 🅑 OpenID Connect 활성화 설정 🅒 Redirect URI 등록 🅓 동의 화면 미리보기

이 문서는 카카오 로그인 사용 시 필요한 설정에 대해 안내합니다. 이 문서의 모든 설정은 카카오디벨로퍼스(Kakao Developers, 이하 개발자 웹사이트)의 [내 애플리케이션]에서 설정할 수 있습니다. 각 제목에 부착된 태그(Tag)는 다음과 같은 의미입니다.

회원 가입이 필요한 서비스는 카카오 로그인 사용자를 서비스 회원 가입 처리해야 합니다.

다음은 사용자 정보 가져오기를 통해 제공받을 수 있는 사용자의 기본 정보와 카카오계정 정보입니다. 이 정보들은 앱에 동의 항목을 설정하지 않아도 제공받을 수 있습니다.

카카오 플랫폼은 ➎ 토큰 발급 시점에 ➏ 사용자와 앱을 연결합니다.

사용자는 동의 화면에서 🅐 개인정보 제공 안내를 확인하고, 🅑 서비스 이용에 필요한 동의 항목에 동의할 수 있습니다.

사용자가 로그아웃 버튼을 눌러 연결 페이지로 진입합니다. 사용자가 서비스만 로그아웃, 카카오계정과 함께 로그아웃 중 원하는 로그아웃 처리를 선택합니다. 사용자가 서비스만 로그아웃을 선택했다면 즉시 앱 정보에 등록된 Logout Redirect URI로 리다이렉트됩니다. 사용자가 카카오계정과 함께 로그아웃을 선택했다면 카카오계정 로그인 상태에 따라 다음과 같이 동작합니다. 카카오계정 세션이 존재할 경우, 카카오계정 세션을 만료시킨 후 앱 정보에 등록된 Logout Redirect URI로 리다이렉트됩니다. 카카오계정 세션이 존재하지 않을 경우, 즉시 앱 정보에 등록된 Logout Redirect URI로 리다이렉트됩니다.

서비스 로그아웃 버튼을 통해 서비스 로그아웃 시 카카오계정도 동시에 로그아웃 처리하고 싶다면 카카오계정과 함께 로그아웃 기능을 사용합니다.

다음은 서비스에서 제공받을 수 있는 카카오 로그인 사용자의 카카오계정 정보입니다. 카카오계정 정보를 제공받으려면 앱에 개인정보 동의 항목을 설정해야 합니다.

서비스는 ➊ 카카오 로그인을 통해 서비스를 이용 중이던 사용자가 탈퇴 또는 카카오 로그인 연동 해제를 요청하면 ➋ 해당 사용자에 대해 연결 끊기를 요청합니다. 카카오 플랫폼은 ➌ 사용자와 앱의 연결을 해제하고 로그아웃 처리합니다. 서비스는 연결 끊기 요청 성공 시 ➎ 해당 사용자를 탈퇴 또는 카카오 로그인 연동 해제 처리합니다.

이밖에도

단, 동의 항목을 설정했더라도 카카오에서 정보 제공이 불가능한 경우가 있으므로, 사용자 동의 시 정보 제공 가능 여부를 참고하여 서비스에서 자체 수집해야 합니다.

서비스는 ➎ 토큰 요청 및 발급을 통해 카카오 로그인을 완료한 후, ➐ 가입 및 로그인 처리를 해야 합니다.

응답 내용은 REST API와 동일하므로 사용자 정보를 참고합니다.

등록된 앱이 없다면 애플리케이션을 참고해

업데이트에서 사라질 텍스트

업데이트에서 살아남은 텍스트