REST API이 문서는 REST API를 사용한 로그인 구현 방법을 안내합니다. Show 이 문서에 포함된 기능 일부는 [도구] > [REST API 테스트]를 통해 사용해 볼 수 있습니다. 카카오 로그인 구현에 필요한 로그인 버튼 이미지는 [도구] > [리소스 다운로드]에서 제공합니다. 해당 로그인 버튼은 디자인 가이드를 참고하여 서비스 UI에 적합한 크기로 수정하여 사용할 수 있습니다. 시작하기 전에카카오 로그인 과정REST API를 사용한 카카오 로그인은 PC 및 모바일 웹에서 카카오 로그인 구현 시 적합한 방식입니다. 다음은 REST API를 사용한 카카오 로그인 과정을 나타낸 시퀀스 다이어그램(Sequence diagram)입니다. 단계별 안내를 함께 참고합니다.
카카오계정 세션 클라이언트에서 사용자가 이미 카카오계정으로 로그인한 상태라면 카카오계정 세션이 존재합니다. 로그인 시 카카오계정 세션의 인증 시간은 기본 24시간이며, 최초 인증 후 세션 시간은 변경되지 않습니다. 사용자가 카카오계정 로그인 화면에서 [로그인 상태 유지]를 선택한 경우에는 인증 시간이 1달입니다. 간편 로그인 모바일 웹 환경에서는 Kakao SDK for JavaScript의 간편 로그인을 사용할 수 있습니다. 간편 로그인 사용 시, 사용자가 카카오계정 ID와 비밀번호를 입력하지 않고도 카카오톡을 통해 인증을 받아 간편하게 로그인할 수 있습니다. Step 2. 토큰 받기
Step 3. 사용자 로그인 처리 주의 서비스의 사용자 로그인 처리는 서비스에서 자체 구현해야 합니다. 이 문서는 사용자 로그인 처리 구현 시 참고할 수 있는 정보를 제공합니다.
카카오 로그인인가 코드 받기기본 정보
카카오 로그인 동의 화면을 호출하고, 사용자 동의를 거쳐 인가 코드를 발급합니다. 동의 화면은 앱에 설정된 동의 항목에 대해 사용자에게 인가(동의)를 구합니다. 인가 코드는 동의 화면을 통해 인가받은 동의 항목 정보를 갖고 있으며, 인가 코드를 사용해 토큰 받기를 요청할 수 있습니다. OpenID Connect를 사용하는 앱일 경우, 앱 설정에 따라 ID 토큰을 함께 발급받을 수 있는 인가 코드를 발급합니다. 동의 화면 동의 화면은 사용자와 앱이 처음 연결될 때만 나타납니다. 사용자가 이미 동의 화면에서 서비스 이용에 필요한 동의 항목에 동의 완료한 경우, 해당 사용자의 카카오 로그인 시에는 동의 화면이 나타나지 않고 즉시 인가 코드가 발급됩니다. 사용자와 앱이 연결된 이후 다시 동의 화면을 통해 특정 동의 항목에 대한 사용자 동의를 요청하려면 추가 항목 동의 받기로 동의 화면을 호출할 수 있습니다. 서비스 가입 과정이 올바르게 완료되지 않아 다시 동의 화면을 호출해야 할 경우에는 연결 끊기 후 다시 인가 코드 받기를 요청합니다. 인가 코드 받기 요청은 웹 브라우저 또는 웹뷰의 카카오계정 세션 존재 여부에 따라 다르게 동작합니다.
사용자는 동의 화면에서 서비스 이용에 필요한 동의 항목에 동의하고 로그인하거나 로그인을 취소할 수 있습니다. 카카오 인증 서버는 사용자의 선택에 따라 요청 처리 결과를 담은 쿼리 스트링(Query string)을
서비스 서버는
RequestParameter
* auth_type: Deprecated, prompt를 사용하도록 변경 Response
SampleRequest
Response: 사용자가 [동의하고 계속하기] 선택, 로그인 진행
Response: 로그인 취소
토큰 받기기본 정보
인가 코드로 토큰 발급을 요청합니다. 인가 코드 받기만으로는 카카오 로그인이 완료되지 않으며, 토큰 받기까지 마쳐야 카카오 로그인을 정상적으로 완료할 수 있습니다. 필수 파라미터를 포함해 액세스 토큰으로 사용자 정보 가져오기와 같은 카카오 API를 호출할 수 있습니다. 토큰 정보 보기로 액세스 토큰 유효성 검증 후, 사용자 정보 가져오기를 요청해 필요한 사용자 정보를 받아 서비스 회원 가입 및 로그인을 완료합니다. RequestParameter
Response
참고: ID 토큰 페이로드
SampleRequest
Response: 성공
Response: 성공, OpenID Connect를 활성화한 앱, ID 토큰 포함
Response: ID 토큰 페이로드 예시
추가 기능인가 코드 받기 요청 시 사용할 수 있는 추가 기능은 다음과 같습니다.
추가 항목 동의 받기추가 항목 동의 받기는 사용자가 동의하지 않은 동의 항목에 대한 추가 동의를 요청하는 추가 기능입니다. 인가 코드 받기 요청 시
주의: OpenID Connect OpenID Connect를 사용하는 앱의 경우, 추가 항목 동의 받기 요청 시 동의 항목 키를 전달하는 scope 파라미터 값에 openid를 반드시 포함해야 합니다. 해당 파라미터 값을 포함하지 않을 경우, ID 토큰이 재발급되지 않습니다. (참고: scope 파라미터) 카카오톡에서 자동 로그인하기카카오톡에서 자동 로그인은 카카오톡 인앱브라우저를 통한 서비스 페이지 진입 시 서비스 가입 여부에 따른 분기 처리를 지원하는 추가 기능입니다. 이해하기에서 자세한 안내를 확인한 후 사용해야 합니다. 인가 코드 받기 요청 시
서비스 가입을 완료하지 않아 아직 앱과 연결되지 않은 사용자인 경우, 아래와 같이 사용자 동의가 필요하다는 에러 응답이 약관 선택해 동의 받기카카오싱크 전용 카카오싱크를 도입한 서비스만 사용할 수 있는 기능입니다. 약관 선택해 동의 받기는 카카오 로그인 동의 화면에 포함할 서비스 약관을 지정하는 추가 기능입니다. 사용자의 서비스 가입 시나리오에 따라 앱에 등록된 서비스 약관 중
특정 서비스 약관을 지정해 동의받고자 할 때 사용합니다. 인가 코드 받기 요청 시 OpenID Connect ID 토큰 발급하기OpenID Connect 사용 서비스인 경우,
OpenID Connect 활성화 설정이 되어 있다면 별도 파라미터 없이도 ID 토큰을 함께 발급받을 수 있습니다. OpenID Connect 사용 시 ID 토큰 재생 공격을 방지하기 위해 기존 로그인 여부와 상관없이 로그인하기기존 로그인 여부와 상관없이 로그인하기는 서비스의 필요에 따라 사용자 인증을 다시 수행하고자 할 때 사용하는 추가 기능입니다. 이 기능을 사용하면 사용자가 브라우저에 카카오계정으로 로그인되어 있는 상태라도 다시 카카오계정으로 로그인하는 과정을 거쳐 서비스에 카카오
로그인하도록 할 수 있습니다. 인가 코드 받기 요청 시
로그아웃기본 정보
사용자 액세스 토큰과 리프레시 토큰을 모두 만료시킵니다. 사용자가 서비스에서 로그아웃할 때 이 API를 호출하여 더 이상 해당 사용자의 정보로 카카오 API를 호출할 수 없도록 합니다. 로그아웃은 요청 방법에 따라 다음과 같이 동작합니다.
로그아웃 요청 성공 시, 응답 코드와 로그아웃된 사용자의 회원번호를 받습니다. 로그아웃 시에도 웹 브라우저의 카카오계정 세션은 만료되지 않고, 로그아웃을 호출한 앱의 토큰만 만료됩니다. 따라서 웹 브라우저의 카카오계정 로그인 상태는 로그아웃을 호출해도 유지됩니다. 로그아웃 후에는 서비스 초기 화면으로 리다이렉트하는 등 후속 조치를 취하도록 합니다. 참고: 카카오계정 로그아웃서비스에서 필요에 따라 웹 브라우저의 카카오계정 로그인 상태 또한 로그아웃 처리하여야 할 때는 추가 기능인 카카오계정과 함께 로그아웃을 사용해 카카오계정 세션을 만료시켜야 합니다. Request: 액세스 토큰 사용Header
Request: 어드민 키 사용Header
Parameter
Response
SampleRequest: 액세스 토큰 사용
Request: 어드민 키 사용
Response
카카오계정과 함께 로그아웃기본 정보
카카오계정과 함께 로그아웃은 웹 브라우저에 로그인된 카카오계정의 세션을 만료시키고, 서비스에서도 로그아웃 처리할 때 사용하는 로그아웃 추가 기능입니다. 카카오계정과 함께 로그아웃 기능의 설명과 동작에 대한 자세한 내용은 이해하기, 설정 방법은 설정하기를 각각 참고합니다. 기본적인 로그아웃은 토큰을 만료시켜 해당 사용자 정보로 더 이상 카카오 API를 호출할 수 없도록 하는
기능으로, 서비스 로그아웃과 카카오계정 로그아웃을 각각 수행해야 합니다. 이와 달리 카카오계정과 함께 로그아웃 기능은 카카오계정 로그아웃 처리 후 기능 동작이 다르기 때문에 기본적인 로그아웃과 카카오계정과 함께 로그아웃은 요청 URL 및 파라미터가 서로 다른 점에 유의합니다. 앱의 REST API 키를 서비스 서버의 RequestParameter
Response
SampleRequest
Response
연결 끊기기본 정보
연결 끊기는 앱과 사용자 카카오계정의 연결을 끊는 기능입니다. 자세한 설명은 연결과 연결 끊기를 참고합니다. REST API 사용 시 연결 끊기는 사용자의 액세스 토큰 또는 앱 어드민 키(Admin key)로 API를 호출할 수 있습니다. 서비스 종료 등 상황에 따라 토큰으로 연결 끊기를 요청할 수 없는 경우가 있기 때문에 앱 어드민 키를 사용한 요청을 지원합니다. 하지만 앱 어드민 키는 절대로 유출되어선 안 되는 중요한 키입니다. 정보 보안을 위해 어드민 키를 사용한 REST API 요청은 꼭 서버에서만 사용하고, 소스 코드에는 어드민 키를 사용하지 않도록 유의합니다. 어드민 키를 사용해 연결 끊기를 할 경우, 대상 사용자를 명시하는 파라미터를 함께 보내야 합니다. 연결 끊기 요청에 성공하면 해당 사용자 회원번호를 응답으로 받습니다. 또한 로그아웃이 함께 진행되어 액세스 토큰과 리프레시 토큰이 만료 처리됩니다. Request: 액세스 토큰 사용Header
Request: 어드민 키 사용Header
Parameter
Response
SampleRequest: 액세스 토큰 사용
Request: 어드민 키 사용
Response
토큰 정보 보기기본 정보
액세스 토큰의 유효성을 검증하거나 정보를 확인합니다. 토큰 만료 여부나 유효기간을 알 수 있어 갱신 과정에 활용할 수 있습니다. 액세스 토큰을 요청 헤더(Header)에 담아 응답은
이 외 에러는 앱이나 사용자, 토큰 등의 상태가 더 이상 유효하지 않아 쓸 수 없는 경우로 로그아웃 처리를 권장합니다. RequestHeader
Response
* appId: Deprecated, app_id를 사용하도록 변경 * expiresInMillis: Deprecated, expires_in을 사용하도록 변경 SampleRequest
Response
토큰 갱신하기기본 정보
액세스 토큰과 리프레시 토큰을 갱신합니다. JavaScript SDK 사용 시에도 보안 정책으로 인해 REST API로 액세스 토큰을 갱신합니다. 리프레시 토큰 값과 필수 파라미터를 담아 응답은 토큰 받기와 마찬가지로 참고: ID 토큰 갱신OpenID Connect를 통해 ID 토큰과 함께 발급된 리프레시 토큰으로 토큰 갱신을 요청한 경우, 액세스 토큰과 ID 토큰이 함께 갱신되어 응답에 포함됩니다. OpenID Connect를 사용하지 않는 앱의 토큰 갱신 시에는 ID 토큰이 응답에 포함되지 않습니다. RequestParameter
Response
SampleRequest
Response
사용자 정보 가져오기기본 정보
현재 로그인한 사용자의 정보를 불러옵니다. 이 API를 사용하려면 동의 항목 설정을 참고하여 각 응답 필드에 필요한 동의 항목을 설정해야 합니다. 동의 항목이 설정되어 있더라도 사용자가 동의하지 않으면 사용자 정보를 받을 수 없습니다. 동의 내역 확인하기 API를 통해 사용자가 동의한 동의 항목을 먼저 확인할 수 있습니다. 사용자 액세스 토큰 또는 어드민 키를
헤더(Header)에 담아
사용자 정보에는 [내 애플리케이션] > [사용자 프로퍼티] 메뉴에서 설정한 사용자 프로퍼티가 포함됩니다. 사용자 정보 요청 성공 시, 응답 바디(Body)는 사용자 정보를 포함한 Request: 액세스 토큰 사용Header
Parameter
Request: 어드민 키 사용Header
Parameter
property_keys
* properties.nickname, properties.profile_image, properties.thumbnail_image: Deprecated, 공지 참고 Response
* UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고 KakaoAccount
* UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고 * has_${FIELD_NAME}: Deprecated, 각 사용자 정보 값 소유 여부(Boolean), API를 통한 해당 사용자 정보의 제공 가능 여부를 확인하는 용도로 사용할 수 없음, needs_agreement 참고 프로필 정보 동의 항목 분리 2021년 6월 25일부터 프로필 정보가 [닉네임]과 [프로필 사진]으로 분리되어 제공됩니다. 분리된 동의 항목인 [닉네임]과 [프로필 사진] 동의 항목을 각각 설정하여 서비스에 필요한 프로필 정보만 선택적으로 제공받을 수 있습니다. 기존 [프로필(닉네임/프로필 사진)] 동의 항목을 사용 중인 앱에서는 기존과 같이 해당 동의 항목을 통해 닉네임과 프로필 사진 정보를 모두 받을 수 있습니다. 기존 동의 항목을 사용하던 앱에서 분리된 동의 항목을 사용하려면 데브톡을 통해 변경을 요청합니다. 이 경우, 응답 구성이 변경될 수 있으므로 주의합니다. 자세한 사항은 공지사항을 참고합니다. profile
SampleRequest: 액세스 토큰 사용하여 모든 정보 받기
Request: 액세스 토큰 사용하여 email 정보 받기
Request: 어드민 키 사용하여 email 정보 받기
Response: 성공, 모든 사용자 정보 포함
Response: 성공, 앱에 닉네임 동의 항목만 설정하고 사용자에게 동의받은 경우
여러 사용자 정보 가져오기기본 정보
앱 사용자 여러 명의 정보를 불러옵니다. 이 API는 관리자를 위한 것으로, 앱 어드민 키를 사용하기 때문에 반드시 서버에서만 호출해야 합니다. 앱 어드민 키를 헤더에 담아 응답은 요청 시 지정한 사용자 정보 목록을 포함합니다. 이 API의 기본 응답은 회원번호, 연결 시각과 같은 기본적인 정보만 포함합니다.
조회할 사용자 정보에 하위 항목이 존재하는 경우, 다음과 같이 상위 항목의 키에 온점(.)을 추가해 모든 하위 항목을 요청할 수 있습니다.
특정 하위 항목만 요청하려면, 다음과 같이 온점(.) 뒤에 하위 항목의 키를 명시하여 전달합니다.
세트로 구성된 응답은 관련
정보가 함께 전달됩니다. 예를 들어 사용자 정보 전체를 요청하려면 아래와 같이
별도 파라미터 지정 없이 특정 사용자 한 명의 사용자 정보 전체를 요청하려면 사용자 정보 가져오기 API를 사용합니다. RequestHeader
Parameter
Response
users_info
* UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고 SampleRequest
Request: property_keys로 이메일, 프로필 지정 요청
Request: 조회 가능한 모든 사용자 정보 요청
Response
Response: property_keys로 이메일, 프로필 지정 요청
Response: 모든 사용자 정보 요청
사용자 목록 가져오기기본 정보
앱의 사용자 회원번호 목록을 제공하는 API입니다. 이 API는 관리자를 위한 것으로, 앱 어드민 키를 사용하기 때문에 반드시 서버에서만 호출해야 합니다. 앱 어드민 키를 헤더에 담아 RequestHeader
Parameter
Response
* total_count: Deprecated, 앱의 사용자 수(Integer), 사용자 통계는 [내 애플리케이션] > [통계] > [사용자]에서 확인 가능, 공지 참고 SampleRequest: 첫 사용자 100명 정보 받기
Request: 회원번호 12345와 그보다 큰 회원번호를 가진 사용자 3명 정보 보기
Response
사용자 정보 저장하기기본 정보
사용자 프로퍼티에 값을 저장합니다. 키 값은 [내 애플리케이션] > [사용자 프로퍼티]에 정의한 값을 사용해야 합니다.
저장한 사용자 프로퍼티는 사용자 정보 가져오기를 통해 사용할 수 있습니다. 해당 사용자의 정보 전체를 불러오거나, 파라미터로 특정 정보만 지정해 불러올 수 있습니다. RequestHeader
Parameter
Response
SampleRequest
Response
배송지 가져오기기본 정보
특정 사용자의 배송지 정보를 가져옵니다. 이 API는 액세스 토큰으로 요청하는 방식, 서비스 관리자가 애플리케이션(이하 앱)의 어드민 키와 회원번호로 요청하는 방식 두 가지로 제공됩니다. 서버에서 배송지를 요청할 때는 요청 헤더(Header)에 사용자 토큰 대신 어드민 키를 사용하고, 배송지를 조회할 사용자를 지정해야 합니다. 응답에 Request: 액세스 토큰 사용Parameter
Request: 어드민 키 사용Parameter
Response
* has_shipping_addresse: Deprecated, 배송지 정보 값 소유 여부(Boolean), API를 통한 해당 사용자 정보의 제공 가능 여부를 확인하는 용도로 사용할 수 없음, needs_agreement 참고 ShippingAddress
SampleRequest: 액세스 토큰 사용
Request: 어드민 키 사용
Response
동의 내역 확인하기기본 정보
사용자가 동의한 동의 항목의 상세 정보 목록을 조회합니다. [내 애플리케이션] > [카카오 로그인] > [동의 항목]에 설정된 동의 항목의 목록과 사용자가 동의한 동의 항목의 상세 정보를 반환합니다. 사용자가 기존에 동의했던 동의 항목이라면 현재 앱에 사용하도록 설정돼 있지 않아도 응답에 포함됩니다. 사용자 액세스 토큰을 사용하는 방법, 앱 어드민 키를 사용하는 방법 두 가지로 제공됩니다. 사용자 액세스 토큰 또는 어드민 키를 헤더(Header)에 담아 성공 시 앱에서 설정한 동의 항목(Scope) 목록을 받습니다. 사용자가 동의한 항목은 Request: 액세스 토큰 사용Header
Parameter
Request: 어드민 키 사용Header
Parameter
Response
scopes
SampleRequest: 액세스 토큰 사용
Request: 액세스 토큰 사용하여 특정 동의 항목만 조회
Request: 어드민 키 사용
Response
Response: 이메일, 카카오 서비스 내 친구 목록에 대한 동의 내역
동의 철회하기기본 정보
사용자가 동의한 항목에 대해 동의를 철회합니다. 동의 내역 확인하기를 통해 조회한 동의 항목 정보 중 동의 철회 가능 여부( 액세스 토큰을 사용하는 방법, 앱 어드민 키를 사용하는 방법 두 가지로 제공됩니다. 액세스 토큰 또는 어드민 키를 헤더(Header)에 담고, 동의를 철회할 동의 항목 목록을 전달하여 요청 성공 시 변경된 앱의 동의 항목 정보 목록을 받습니다. 각 동의 항목 사용 설정
여부, 사용자 동의 여부, 철회 가능 여부와 같은 상세 정보를 포함합니다. 동의가 철회된 동의항목은 Request: 액세스 토큰 사용Header
Parameter
Request: 어드민 키 사용Header
Parameter
Response
SampleRequest: 액세스 토큰 사용
Request: 어드민 키 사용
Response
Response: 실패, 필수 동의 항목의 철회를 요청한 경우
Response: 실패, 철회할 동의 항목 ID가 잘못된 경우
동의한 약관 확인하기카카오싱크 전용 카카오싱크를 도입한 서비스만 사용할 수 있는 기능입니다. 기본 정보
특정 사용자가 어떤 약관들에 동의하고 로그인했는지 확인합니다. 액세스 토큰(Access Token)을 헤더에 담아 관리자가 특정 사용자의 서비스 약관 동의 내역을 확인하려면 서버에서 어드민 키(Admin key)로 요청할 수 있습니다. 어드민 키는 앱의 꼭 서버에서 호출할 때만 사용해야 합니다. 어드민 키를 사용해 요청할 경우 응답은 사용자 ID와 약관 태그, 각 약관에 마지막으로 동의한 시간 정보를 포함합니다. 사용자가 서비스를 탈퇴하고 앱과의 연결을 끊은 뒤 로그인하면 다시 간편가입 화면을 통한 동의 절차를 거칩니다. 이에 따라 약관에 동의한 시간 정보가 갱신됩니다. Request: 액세스 토큰 사용Parameter
Request: 어드민 키 사용Parameter
Response
AllowedServiceTerms
AppServiceTerms
SampleRequest: 액세스 토큰 사용
Request: 액세스 토큰 사용, 앱에 설정된 서비스 약관 목록을 함께 요청
Request: 어드민 키 사용
Response
Response: 앱에 설정된 서비스 약관 목록 포함
OpenID Connect이 항목은 카카오 로그인 OpenID Connect 관련 API의 사용 방법을 안내합니다. OIDC: 메타데이터 확인하기기본 정보
카카오 로그인의 OpenID Connect 서비스 제공자 설정을 확인합니다. 카카오 로그인은 OpenID Connect Discovery 표준 규격에 따라 서비스 제공자 설정을 담은 메타데이터(Metadata) 문서를 제공합니다. Response
SampleRequest
Response OIDC: 공개키 목록 조회하기기본 정보
카카오 인증 서버가 ID 토큰 서명 시 사용한 공개키 목록을 조회합니다. 공개키는 일정 주기 또는 특별한 이슈 발생 시 변경될 수 있습니다. 주기적으로 최신 공개키 목록을 조회한 후, 일정 기간 캐싱(Caching)하여 사용할 것을 권장합니다. 지나치게 빈번한 공개키 목록 조회 요청 시, 요청이 차단될 수 있습니다. 요청 성공 시, Request
Response
JWK
Sample: 요청
Sample: 응답, 성공 OIDC: ID 토큰 정보 보기기본 정보
주의: API 용도 ID 토큰 정보 보기 API는 디버깅(Debugging) 용도로 제공되며, 실제 서비스의 ID 토큰 유효성 검증 용도로 사용할 수 없습니다. 용도에 맞지 않는 요청은 차단될 수 있습니다. ID 토큰 유효성 검증을 위한 참고 정보를 제공합니다. 서비스에서 OpenID Connect(OIDC)를 통해 발급받은 ID 토큰 유효성을 검증할 때, 직접 확인한 페이로드(Payload) 값이 이 API의 응답이 일치하는지 대조하여 확인하는 용도로 사용합니다.
RequestParameter
Response
Sample: 요청
Response: 응답, 성공
Sample: 응답, 실패, 유효하지 않은 ID 토큰 OIDC: 사용자 정보 가져오기기본 정보
현재 로그인한 사용자의 정보를 불러옵니다. 이 API는 카카오계정의 기본적인 사용자 정보만을 제공하며, 이 외 사용자 정보는 사용자 정보 가져오기 API를 통해 받을 수 있습니다. 사용자 정보의 종류와 상세 설명은 사용자 정보를 참고합니다. 사용자 액세스 토큰을 헤더에 담아 Request
Response
Sample: 요청
Sample: 응답, 성공
고급: 연결하기기본 정보
주의: 자동 연결 사용 여부 확인 연결하기는 자동 연결을 사용하지 않는 앱에서만 사용하는 API입니다. 사용 중인 앱의 자동 연결 사용 여부는 [내 애플리케이션] > [카카오 로그인] > [로그인 시 앱 자동 연결] 메뉴에서 확인할 수 있습니다. 해당 설정이 노출되지 않는다면 자동 연결을 사용하는 앱입니다. [로그인 시 앱 자동 연결] 설정이 노출된다면 자동 연결 사용 여부를 설정할 수 있는 앱으로, [사용 안함]으로 설정돼 있을 경우 연결하기 API를 사용해야 합니다. 연결하기 API는 자동 연결을 [사용 안함]으로 설정한 앱에서 앱과 사용자를 수동으로 연결하는 기능입니다. 자동 연결은 카카오 로그인 완료 시 앱과 사용자를 자동으로 연결하는 기능으로, 필요 시 카카오와 협의를 거쳐 자동 연결의 사용 여부를 설정할 수 있습니다. 다음은 앱과 사용자를 수동으로 연결하고자 하는 경우의 예시입니다.
자동 연결을 사용하지 않는 서비스는 반드시 연결하기를 호출해 사용자와 앱을 직접 연결해야 합니다. 또한 사용자의 서비스 가입 상태와 앱 연결 상태가 일치하는지 확인하고 연결하기 및 연결 끊기를 사용해 사용자의 연결 상태를 관리해야 합니다. 따라서 반드시 필요한 경우가 아니라면 기본 설정인 자동 연결을 사용하는 것을 권장합니다. 가입 미완료자 연결 끊기 처리 사용자가 연결 대기 상태에서 24시간 안에 연결하기 API를 통해 연결 완료되지 않는다면, 가입 미완료자로 분류되어 카카오 API 플랫폼에서 연결 끊기 처리합니다. 연결 끊기 시 연결 끊기 알림 설정이 되어 있다면 콜백(Callback)이 전달되므로, 서비스에서도 해당 사용자에 대해 연결 끊기 요청 및 사용자 정보 삭제를 해야 합니다. 자세한 정보는 공지사항을 참고합니다. 액세스 토큰을 헤더에 담아 참고: 사용자 연결 상태에 따른 사용자 정보 제공 범위사용자가 앱과 연결하기 API를 통해 연결 완료되지 않은 연결 대기(Preregistered) 상태인 경우, 다음의 일부 사용자 정보만 사용자 정보 가져오기 및 여러 사용자 정보 가져오기 API를 통해 제공됩니다.
RequestHeader
Parameter
Response
SampleRequest: 사용자 프로퍼티 저장 없이 연결하기만 요청
Request: 연결하기 요청 시 사용자 프로퍼티 저장
Response: 성공
Response: 실패, 앱과 이미 연결되어 있는 사용자인 경우
Response: 실패, 요청 시 사용한 액세스 토큰이 유효하지 않은 경우
Response: 실패, 앱에 설정돼 있지 않은 사용자 프로퍼티 저장을 요청한 경우
더보기 |