사이드 메뉴
커뮤니케이션
API 제공
어드민 API
이용 안내
카카오 API 개요
이 문서는 카카오 API를 처음 사용하는 카카오 및 공동체 서비스에 필요한 정보를 안내합니다.
호스트, 호출 서비스, 제공 범위로 구분해 제공하는 카카오 API의 종류에 대해 안내합니다.
| 구분 | 설명 |
|---|---|
KAUTH | kauth.kakao.com카카오 로그인 API, API 목록에서 사용 가능한 API 목록 확인 가능 |
KAPI | kapi.kakao.comAPI 목록에서 사용 가능한 API 목록 확인 가능 |
DAPI | dapi.kakao.comAPIHub에서 상세 정보 확인 가능 |
| 구분 | 설명 |
|---|---|
| 내부 API | 카카오, 공동체만 호출 가능한 API 카카오: 사내망에서는 http로, 허용된 외부망에서는 https로 호출 가능공동체: 사내망, 허용된 외부망 모두 https로만 호출 가능 참고: 방화벽 |
| 외부 API | 공용망(Public network)에서 호출 가능한 API 서버와 클라이언트 모두 호출 가능 |
| 배치 API | 대량 호출에 최적화된 내부 API 카카오, 공동체만 호출 가능 참고: 방화벽 |
| 구분 | 설명 |
|---|---|
| 제휴(Partner) API | 카카오, 공동체, 제휴 파트너에게만 제공하는 API |
| 오픈(Open) API | 모두에게 제공하는 API |
카카오 API 플랫폼의 앱은 페이즈별로 등록되므로, 앱에 해당하는 페이즈의 호스트로 API를 호출해야 합니다. 아래 호스트(Host)별 페이즈(Phase) 정보를 확인합니다.
| 페이즈 | 호스트 |
|---|---|
| 알파(Alpha) | https://alpha-kauth.kakao.com |
| 샌드박스(Sandbox) | https://sandbox-kauth.kakao.com |
| 베타(Beta) | https://beta-kauth.kakao.com |
| 프로덕션(Production) | https://kauth.kakao.com |
| 페이즈 | 호스트 |
|---|---|
| 알파(Alpha) | https://alpha-kapi.kakao.com |
| 샌드박스(Sandbox) | https://sandbox-kapi.kakao.com |
| 베타(Beta) | https://beta-kapi.kakao.com |
| 프로덕션(Production) | https://kapi.kakao.com |
| 페이즈 | 호스트 |
|---|---|
| 베타(Beta) | https://beta-dapi.kakao.com |
| 프로덕션(Production) | https://dapi.kakao.com |
카카오 API의 요청과 응답에 포함된 ID 종류에 대해 안내합니다. 개발자 계정 ID 관련 내용은 개발자 계정과 개발자 계정 ID를 참고합니다.
Permission
: 해당 ID를 사용하려면 별도 권한 필요
| ID | 타입 | 설명 |
|---|---|---|
user_id(회원번호) | Long | 카카오계정과 앱이 연결될 때 부여하는 앱별 사용자 ID 앱 ID( app_id)와 카카오계정 ID(account_id)의 조합으로 구성재연결 시에도 같은 값으로 유지(사용자 ID 고정을 사용하도록 설정한 경우) 활용 예시: 카카오 API 호출 시 사용자 식별자로 사용(권장) |
account_id(카카오계정 ID) Permission | Integer | 카카오계정의 고유(Unique) ID 사용자마다 카카오계정 탈퇴 시까지 같은 값으로 유지 활용 예시: 사용자 ID 고정을 비활성화한 경우 사용자 식별자로 사용( user_id 대체) |
talk_id,talk_user_id(카카오톡 회원번호) Permission | Long | 카카오톡 가입 시 부여되는 고유 ID로 전화번호 기반으로 구성 사용자마다 카카오톡 탈퇴 시까지 같은 값으로 유지 활용 예시: 카카오 소셜, 카카오톡 메시지 등 일부 카카오 API 호출 시 사용자 식별자로 사용 가능 |
uuid(고유 ID) Permission | String | 사용자 고유 ID 앱 ID( app_id), 카카오톡 회원번호(talk_id), 카카오계정 ID(account_id)의 조합으로 구성앱과 연결되지 않은 사용자(미가입자)에게도 발급되고, 앱 연결로 인해 값이 변경되지 않음 사용자마다 카카오톡 또는 카카오계정 탈퇴 시까지 같은 값으로 유지 활용 예시: 카카오톡 메시지 API의 송수신자 식별자로 사용 초대 메시지로 가입(연결)한 사용자인지 사용자 정보 조회 응답의 uuid 값으로 확인 |