이 문서는 카카오 또는 공동체 서비스의 앱에 적용할 수 있는 추가 설정 방법을 안내합니다. 공통 설명은 오픈 문서를 참고합니다.
카카오 또는 공동체 서비스의 앱은 추가 권한이 부여된 앱 타입을 가질 수 있습니다. 앱 타입에 대한 자세한 내용과 변경 방법은 앱 타입 변경 요청하기를 참고합니다.
- 웹훅
- 계정 상태 변경 웹훅
- 설정 방법: 계정 상태 변경 웹훅
- 개발 문서: 계정 상태 변경 웹훅
- 카카오톡 공유 웹훅
- 설정 방법: 카카오톡 공유 웹훅
- 개발 문서: 카카오톡 공유 웹훅
- 카카오톡 채널 웹훅
- 설정 방법: 카카오톡 채널 웹훅
- 개발 문서: 카카오톡 채널 웹훅
- 계정 상태 변경 웹훅
카카오 또는 공동체 서비스의 연결 해제 웹훅 설정 방법에 대해 안내합니다. 개발 문서는 연결 해제 웹훅을 참고합니다.
장기간 웹훅 수신 응답이 없거나 오류 발생 빈도가 높은 경우, 연결 해제 웹훅 설정의 [활성화 상태]가 [일시 중지]로 변경되고 더 이상 웹훅이 전달되지 않습니다. 앱 멤버의 메일로 발송된 안내를 참고해 웹훅 처리가 올바르게 이뤄지는지 확인 및 조치 후, [활성화 상태]를 [사용함]으로 변경해야 다시 웹훅을 전달받을 수 있습니다.
앱 관리 페이지의 [앱] > [웹훅] > [연결 해제 웹훅]에서 [웹훅 등록]을 선택합니다. 연결 해제 설정에 따라 필요한 입력 정보는 추가 입력 정보에서 확인할 수 있습니다.
[A] 연결 해제 허용
- 허용함: 사용자가 카카오계정 관리 페이지에서 연결 해제 가능
- 허용하지 않음: 사용자의 연결 해제가 불가하며 서비스에서 직접 탈퇴만 가능, 법적 또는 금전 관련 문제와 같이 중요 사유가 존재하는 경우 설정
[B] 연결 해제 시 삭제할 사용자 정보
- 없음: 서비스 내 저장된 사용자 정보 또는 부가 데이터가 없는 경우
- 삭제 필요한 정보 있음: 서비스 내 저장된 사용자 정보 또는 부가 데이터가 존재하는 경우
중요: 카카오 및 공동체 서비스는 가입과 앱 연결 상태를 동일하게 관리하기 위한 연결 해제 웹훅 설정이 필수이므로 해당 값으로 선택 필요
[C] 연결 해제 가능 사용자 확인
- 표시 조건: [A] 연결 해제 허용을 [허용함]으로, [B] 연결 해제 시 삭제할 사용자 정보를 [삭제 필요한 정보 있음]으로 선택한 경우만 입력 창 표시
- 필요 없음: 모든 사용자에게 연결 해제를 허용하는 경우
- 확인 필요한 사용자 있음: 사용자중 일부만 연결 해제를 허용해야 하는 경우
[다음]을 선택하면 웹훅을 설정할 수 있습니다.
[D] 도메인: 카카오로부터 웹훅을 받아 처리할 서버의 도메인 주소
[E] 연결 해제 웹훅: 서비스 서버에서 연결 해제 웹훅 요청을 받을 메서드(GET 또는 POST)와 요청 경로
[F] 로그아웃 웹훅: 서비스 서버에서 로그아웃 웹훅 요청을 받을 메서드(GET 또는 POST)와 요청 경로, 로그아웃 웹훅 참고
연결 해제 설정에 따라 필요한 추가 입력 정보입니다. 설정별 카카오계정 관리 페이지의 UI 및 동작은 연결 해제 정책에 따른 UI 및 동작에서 확인할 수 있습니다.
| 연결 해제 | 삭제할 사용자 정보 | 사용자 확인 | 추가 입력 정보 |
|---|---|---|---|
| 허용함 | 없음 | - | - |
| 허용함 | 삭제 필요한 정보 있음 | 필요 없음 | 사용자 정보 삭제 관련 추가 정보 |
| 연결 해제 | 삭제할 사용자 정보 | 사용자 확인 | 추가 입력 정보 |
|---|---|---|---|
| 허용함 | 삭제 필요한 정보 있음 | 확인 필요한 사용자 있음 | 사용자 정보 삭제 관련 추가 정보 연결 해제 불가 사유 API |
| 연결 해제 | 삭제할 사용자 정보 | 추가 입력 정보 |
|---|---|---|
| 허용하지 않음 | 없음 | 사용자 연결 해제 시도 시 표시 메시지 |
| 허용하지 않음 | 삭제 필요한 정보 있음 | 사용자 정보 삭제 관련 추가 정보 사용자 연결 해제 시도 시 표시 메시지 |
연결 해제 시 삭제할 사용자 정보가 있는 서비스는 사용자 정보 삭제 관련 추가 정보를 입력해야 합니다. 아래 표를 참고합니다.
| 항목 | 설명 |
|---|---|
| 와치센터 ID | 연결 해제 설정 변경 또는 웹훅 API 혹은 연결 해제 불가 사유 API 호출 실패 시 알림 발송 (참고: LDAP ID로 로그인, FAQ) |
| 도메인 | 경로를 제외한 프로토콜, 도메인 이름, 포트만 포함 가능 |
| 연결 해제 웹훅 | 메서드 및 상세 URI 지정, 전송 계층 보안(TLS)이 적용되어 있어야 함 |
| 로그아웃 웹훅 | 메서드 및 상세 URI 지정, 전송 계층 보안(TLS)이 적용되어 있어야 함 |
연결 해제를 허용하지 않고 삭제할 사용자 정보가 없는 경우, 사용자가 직접 서비스에서 탈퇴 절차가 필요함을 안내하기 위한 메시지를 입력해야 합니다. 서비스 특성에 맞춘 문구로 한국어, 영어, 일본어 모두 입력합니다.
연결 해제가 가능한 사용자인지 확인이 필요한 경우 연결 해제 불가 사유 API 관련 정보를 추가로 입력해야 합니다. 해당 API로 연결 해제를 허용하지 않아야 할 사용자에게 직접 서비스에서 탈퇴 절차가 필요함을 안내합니다.
앱의 연결 해제 정책에 따라 카카오계정 관리 페이지 UI 및 동작이 다릅니다. 아래는 주요 케이스 및 예시 화면입니다.
- 연결된 서비스 관리의 해당 앱 페이지에 [연결 해제] 버튼 하나만 노출
- 연결된 서비스 관리의 해당 앱 페이지의 [연결 해제] > 안내 화면의 [연결 해제] 버튼 클릭 시 연결 해제 수행 후 등록된 웹훅 호출
- 연결된 서비스 관리의 해당 앱 페이지에 [연결 해제] 버튼 하나만 노출
- 연결된 서비스 관리의 해당 앱 페이지의 [연결 해제] 버튼 클릭 시 연결 해제 불가 사유 API 호출
- 연결 해제가 가능하다면 안내 화면의 [연결 해제] 버튼 클릭 시 연결 해제 수행 후 등록된 웹훅 호출
- 안내 화면의 [연결 해제] 버튼 터치 시 출력되는 안내 문구는 연결 해제 불가 사유 API로 지정 가능하며, 해당 화면의 [연결 해제] 버튼 클릭 시 연결 해제 수행 후 등록된 연결 해제 웹훅 호출
- 연결 해제 불가한 사용자로 확인되면 연결 해제 불가 메시지와 [닫기] 버튼 출력, 앱 설정에 따라 [실행] 버튼이 출력될 수 있음
- 연결된 서비스 관리의 해당 앱 페이지에 [연결 해제] 버튼 하나만 노출되며, 해당 버튼 클릭 시 연결 해제 불가 안내 출력
- 사용자에게 노출할 안내 문구는 연결 해제 설정 시 [사용자 연결 해제 시도 시 표시 메시지]에 등록 가능
카카오계정 탈퇴 불가 설정은 카카오계정의 탈퇴 요청을 제한하는 것으로 카카오디벨로퍼스에서 지원하지 않으며, 계정파트에서 별도로 설정합니다. 연결 해제 설정과 연결 해제 불가 사유 API는 각 앱의 연결 해제만 사용되며, 카카오계정 탈퇴 불가 설정과 별개입니다. 연결 해제와 카카오계정 탈퇴에 대해 다른 처리가 필요하다면 연결 해제 불가 사유 API와 카카오계정 탈퇴 불가 사유 API를 각각 등록해야 합니다.
카카오계정 탈퇴 및 카카오계정 탈퇴 불가 사유 API 정보는 탈퇴 계정 처리 가이드, 탈퇴 불가사유 등록하기를 참고합니다
카카오 또는 공동체 서비스의 로그아웃 웹훅 설정 방법에 대해 안내합니다. 개발 문서는 로그아웃 웹훅을 참고합니다.
- 앱 관리 페이지의 [앱] > [웹훅] > [연결 해제]에서 [웹훅 등록] 선택
- [A] 연결 해제 허용을 [허용함]으로, [B] 연결 해제 시 삭제할 사용자 정보를 [삭제 필요한 정보 있음]으로 선택, 각 항목에 대한 설명은 추가 입력 정보 참고
- [다음] 선택
- [D] 도메인과 [F] 로그아웃 웹훅에서 로그아웃 웹훅 요청을 받을 서비스 서버의 도메인과 경로, 메서드 설정
- [저장] 선택
웹훅을 받는 서버의 문제로 타임아웃(Timeout)이 발생하거나 요청에 실패하는 경우에 대응할 수 있도록 와치 센터로 모니터링 및 알림 기능을 제공합니다. 카카오 API 플랫폼이 웹훅 호출에 실패하거나, 성공했으나 3초 이상 시간이 소요될 경우 각 앱에 등록된 와치 센터 ID로 알림 메시지를 전송합니다. 와치 센터 ID는 앱 관리 페이지의 [앱] > [고급] > [와치 센터 알림]에서 확인 및 수정할 수 있습니다.
카카오 로그인으로 발급받는 액세스 토큰(Access token)과 리프레시 토큰(Refresh token)의 만료 시간을 직접 설정할 수 있습니다. 토큰 만료 시간은 토큰이 발급된 시점으로부터 몇 초 이후에 토큰이 만료되는지를 의미하며, 페이즈(Phase)에 따라 아래와 같은 기본 설정값을 갖습니다.
- 알파(Alpha), 샌드박스(Sandbox), 베타(Beta) 페이즈:
- 액세스 토큰 2시간(7,200초), 리프레시 토큰 1일(86,400초)
- 앱 키 타입별 기본 설정값 동일
- 리얼(Real) 페이즈:
- 토큰 정보 참고
- 앱 키 타입별 기본 설정값 다름
앱 관리 페이지의 [앱] > [고급] > [토큰 만료 시간]에서 토큰 만료 시간 설정이 가능합니다. 이 설정은 알파, 샌드박스 페이즈에만 지원되며, 테스트 용도이므로 실제 서비스에서는 사용할 수 없습니다.
[만료 시간 등록]을 선택해 토큰 발급 또는 토큰 갱신 요청 시 사용될 앱 키의 타입별로 토큰 만료 시간을 설정할 수 있습니다.
[A] 액세스 토큰: 액세스 토큰의 만료 시간을 앱 키 타입별로 설정할 수 있습니다. 만료 시간은 초 단위 양의 정수로 입력해야 하며, 필요한 항목만 입력 가능합니다.
[B] 리프레시 토큰: 리프레시 토큰의 만료 시간을 앱 키 타입별로 설정할 수 있습니다. 만료 시간은 초 단위 양의 정수로 입력해야 하며, 필요한 항목만 입력 가능합니다.