- 문서>
- 이용 안내>
- 빠른 시작
이용 안내
빠른 시작
이 문서는 카카오 API를 처음 사용하는 사용자에게 필요한 정보를 안내합니다.
카카오 API
카카오 API는 카카오가 제공하는 오픈 API 및 플랫폼 서비스입니다. 카카오디벨로퍼스는 카카오 API 사용자를 위한 개발자 웹사이트입니다.
카카오 API는 다양한 카카오 서비스의 기능과 데이터를 제공합니다. 제공되는 API 정보는 제품을 참고합니다.
애플리케이션 등록
카카오 API를 사용하려면 애플리케이션(이하 앱)이 필요합니다. 앱은 카카오 API 플랫폼에 등록한 서비스 정보입니다. 각 앱은 카카오 API 요청 허가(Authorization) 여부를 판단하는 데 사용하는 정보인 ID와 키(Key)를 갖습니다.
카카오디벨로퍼스에 서비스 정보를 앱으로 등록합니다. [내 애플리케이션]에서 [애플리케이션 추가하기]를 눌러 새로운 앱을 등록할 수 있습니다. 반드시 서비스의 이름, 아이콘, 회사명을 입력하고 카테고리를 선택해야 합니다.
🅐 앱 아이콘: 서비스 로고 또는 앱 아이콘으로 등록, 128*128 이하 크기 권장, 250KB 미만인 파일만 등록 가능 🅑 앱 이름: 서비스 이름 🅒 회사명: 서비스의 상호, 법인 또는 단체명 🅓 카테고리: 서비스의 카테고리
앱은 서비스별로 한 개여야 합니다. 기존에 카카오 로그인, 카카오톡 공유 등을 이용하고 있어 앱이 이미 등록돼 있는 경우, 새로운 앱을 등록하지 않고 기존 앱을 사용합니다. 관리자 계정을 분실해 기존 앱을 사용할 수 없는 경우, 데브톡에서 앱 소유자 변경을 요청합니다.
카카오 로그인을 사용 중인 서비스인 경우, 새로운 앱을 만들어 사용하면 사용자들이 모두 새로 가입해야 합니다. 동일 사용자에 대해 두 개 이상의 서비스 회원 정보가 등록돼 문제가 발생할 수 있습니다.
[내 애플리케이션] > [앱 키]에서 🅐 앱 ID와 🅑 앱 키를 확인합니다.
🅐 앱 ID: 데브톡 문의 시 사용 🅑 앱 키: 카카오 API 호출 시 사용
비즈니스 설정
아래 비즈니스 설정을 완료하면 카카오 API의 더 다양한 기능을 사용할 수 있습니다.
데모
테스트 도구, 데모, 샘플 앱을 통해 카카오 API를 미리 사용해 볼 수 있습니다.
REST API 테스트
REST API 테스트에서 직접 등록한 서비스 앱으로 카카오 API를 테스트할 수 있습니다. 테스트 도구를 참고해 원하는 앱을 선택하고 사용합니다.
JavaScript SDK 데모
JavaScript SDK 데모에서 직접 등록한 서비스 앱으로 카카오 API를 테스트할 수 있습니다. [코드 확인 및 편집]에서 초기화 코드에 사용된 앱 키를 서비스 앱의 앱 키로 교체해 사용합니다.
<script src="https://t1.kakaocdn.net/kakao_js_sdk/2.4.0/kakao.min.js"
integrity="sha384-mXVrIX2T/Kszp6Z0aEWaA8Nm7J6/ZeWXbL8UpGRjKwWe56Srd/iyNmWMBhcItAjH" crossorigin="anonymous"></script>
<script>
Kakao.init('${APP_KEY}'); // 사용하려는 앱의 JavaScript 키 입력
</script>
개발
카카오 API는 REST API 또는 Kakao SDK로 사용할 수 있습니다. 개발 환경과 구현 방식별로 아래 문서를 참고합니다.
테스트 환경을 위한 별도 앱이 필요할 경우, 테스트 앱을 사용합니다. 테스트 앱을 사용해 실제 서비스 적용 전 개발 환경에서 카카오 API 동작을 미리 확인할 수 있습니다.