이 문서는 애플리케이션(이하 앱)에 대해 안내합니다.
카카오디벨로퍼스(Kakao Developers, 이하 개발자 웹사이트)는 카카오 개발자 웹사이트입니다. 카카오 API는 개발자 웹사이트에 등록된 각각의 애플리케이션 정보 기반으로 동작하므로, 카카오 API를 사용하려면 개발자 웹사이트에 앱을 등록해야 합니다.
카카오 API 사용을 위해 개발자 웹사이트에서 앱을 만들고, 해당 앱에 서비스 이름과 회사명, 아이콘 등 정보를 등록할 수 있습니다. 앱 정보는 서비스 이름, 제3자 정보제공동의 등 법적인 사항과도 관련이 있으므로 실제 서비스와 같은 내용으로 구성되어야 합니다.
개발자 웹사이트에서 로그인한 후, [내 애플리케이션] > [애플리케이션 추가하기]를 눌러 앱을 생성할 수 있습니다.
🅐 앱 아이콘: 서비스 로고 또는 앱 아이콘으로 등록, 128*128 이하 크기 권장, 250KB 미만인 파일만 등록 가능
🅑 앱 이름: 서비스 이름
🅒 사업자명: 서비스의 사업자 이름
🅓 저장: 입력한 기본 정보로 앱 등록
애플리케이션 등록 시 입력하는 위 항목들은 [내 애플리케이션] > [일반] > [기본 정보]에 반영됩니다.
기본 정보는 아래 이미지와 같이 카카오 로그인 동의 화면, 연결된 서비스 관리, 카카오톡 메시지 하단의 출처 등에 표시됩니다. 이를 통해 사용자가 올바른 서비스임을 확인하여 안심하고 서비스를 이용할 수 있도록, 앱 기본 정보를 실제 서비스와 동일하게 입력해야 합니다. 기본 정보를 잘못 등록한 경우, [내 애플리케이션] > [일반] > [기본 정보] 메뉴에서 [수정] 버튼을 눌러 변경할 수 있습니다.
🅐 앱 아이콘 🅑 앱 이름 🅒 사업자명
카카오 로그인을 적용해 놓았던 서비스라면 이미 개발자 웹사이트에 앱이 등록되어 있습니다. 이 경우, 기존 앱이 아닌 새로운 앱을 만들어 카카오 로그인을 이용하면 사용자들이 모두 새로 가입해야 하는 문제가 발생하므로, 앱을 새로 등록하지 않고 기존 앱을 사용해야 합니다. 기존 앱의 소유자를 확인할 수 없다면 FAQ를 참고합니다.
앱을 생성하면 플랫폼별 앱 키(App Key)가 발급됩니다. 발급받은 앱 키는 [내 애플리케이션] > [요약 정보] 또는 [내 애플리케이션] > [앱 키]에서 확인할 수 있습니다. 각 앱 키의 [복사] 버튼으로 값을 그대로 복사해 사용하면 편리합니다.
앱 키는 플랫폼별로 각각 발급됩니다. 카카오 플랫폼은 앱 키 값으로 올바른 API 요청인지 검증하며, 플랫폼에 맞지 않는 앱 키를 사용하면 에러 응답을 반환합니다.
앱 키가 노출되었을 경우, 오너(OWNER)가 앱 키를 재발급할 수 있습니다. 한 번 키가 재발급되면 이전으로 되돌릴 수 없으니 주의합니다. 또한 앱 키를 재발급하면 서비스 애플리케이션이나 웹 사이트에 적용된 앱 키를 변경된 값으로 변경해야 카카오 API를 정상적으로 이용할 수 있습니다.
등록한 앱에서 API를 호출하려면 사용하려는 플랫폼에 대한 정보를 개발자 웹사이트에 등록해야 합니다.
[내 애플리케이션] > [플랫폼] 메뉴에서 서비스에 필요한 플랫폼을 등록합니다.
플랫폼 별로 필요한 정보를 등록하지 않았거나, 등록한 정보가 실제 앱 정보와 다르면 "invalid android_key_hash or ios_bundle_id or web_site_url" 에러가 발생합니다. 해당 에러 발생 시, 플랫폼별로 다음 사항을 확인합니다.
package
속성 값과 동일한지, 키 해시 값이 등록되어 있는지 확인🅐 패키지명(Package Name)
package
속성 값과 동일한 값을 입력합니다.🅑 마켓 URL(Market URL)
🅒 키 해시(Key Hash)
🅓 저장: 플랫폼 정보 등록 및 수정 내용을 저장합니다.
🅐 번들 ID(Bundle ID)
🅑 앱스토어 ID(Appstore ID) 및 마켓 URL(Market URL)
🅒 저장: 플랫폼 정보 등록 및 수정 내용을 저장합니다.
🅐 사이트 도메인
http://
, https://
, file://
형식의 도메인을 등록할 수 있으며, http
와 https
도메인은 둘 중 한 가지만 등록해도 사용할 수 있습니다.🅑 기본 도메인
🅒 저장: 플랫폼 정보 등록 및 수정 내용을 저장합니다.
비즈 앱은 서브 도메인과 카카오 로그인 Redirect URI에 와일드카드 문자를 포함한 URI를 등록할 수 있습니다. 와일드카드 문자를 포함한 서브 도메인 사용 시, 아래 규칙을 준수해야 합니다.
팀은 앱 접근 권한을 관리하는 체계입니다. 앱의 개발 구성원인 팀원으로 등록된 사용자만이 앱 정보를 조회 또는 수정할 수 있습니다. 테스트 앱의 경우, 팀원만 API 호출이 가능합니다.
팀원 권한 종류는 다음과 같습니다.
권한 | 상세 |
---|---|
오너(OWNER) | 앱 소유자 앱 정보 조회 및 수정, 앱 키 재발급, 앱 삭제 등 앱에 대한 모든 권한 보유 |
에디터(EDITOR) | 앱 정보 조회 및 수정 가능 앱 삭제, 팀원 초대, 앱 키 재발급 불가능 |
템플릿 에디터(EDITOR_MESSAGE_TEMPLATE) | 앱 정보 조회, 메시지 템플릿 등록 및 수정 가능 |
리더(READER) | 앱 정보 조회만 가능 |
[내 애플리케이션] > [팀 관리] 메뉴의 [팀원 초대] 버튼을 눌러 팀원을 추가할 수 있습니다.
🅐 팀원 초대
🅑 팀원 정보 및 관리:
비즈 앱(비즈니스 애플리케이션)은 해당 서비스를 소유한 사업자 정보를 등록한 앱을 말합니다.
비즈 앱은 다음과 같은 추가 기능을 이용할 수 있습니다.
[내 애플리케이션] > [비즈니스] > [사업자 정보 등록]을 눌러 사업자등록번호를 입력합니다. 사업자등록번호를 등록하면 곧바로 비즈 앱으로 사용 가능합니다.
사업자등록번호가 없는 개인이나 단체가 제공하는 서비스의 앱이라면, 아래 조건 만족 시 개인 개발자 비즈 앱으로 전환할 수 있습니다.
조건 만족 시, [내 애플리케이션] > [비즈니스] > [개인 개발자 비즈 앱]에서 [개인 개발자 비즈 앱 전환] 버튼을 눌러 앱을 비즈 앱으로 전환 가능합니다.
개인 개발자 비즈 앱은 사업자 정보가 없어 비즈니스 채널 연결이 불가능합니다. 카카오싱크 도입이 필요한 경우, 비즈니스 채널 연결을 위해 사업자 정보를 등록해야 합니다. 개인 개발자 비즈 앱 전환 후에도 [내 애플리케이션] > [비즈니스]에서 사업자 정보를 등록할 수 있습니다.
테스트 앱은 실제로 운영 중인 앱에 영향을 미치지 않고 신규 기능이나 업데이트 개발을 해야 할 때 사용합니다. 실제 서비스에서 사용 중인 앱 설정을 변경하지 않고, 테스트 앱을 사용하여 설정을 변경하며 개발을 진행할 수 있습니다.
테스트 앱은 카카오비즈니스 관리자센터에서 비즈니스 채널과 연결된 비즈 앱에만 제공되는 기능으로 테스트 앱의 팀원만 사용할 수 있습니다.
[내 애플리케이션] > [일반] > [테스트 앱 정보]에서 [테스트앱 생성]을 눌러 생성할 수 있으며, 앱마다 한 개의 테스트 앱을 만들 수 있습니다.
테스트 앱은 별도 앱 키를 가지며, 동의 항목 권한 및 서비스 이용 약관 설정은 원본 앱과 동일하게 설정됩니다. 최초 생성 이후에는 원본 앱의 [내 애플리케이션] > [일반] > [테스트 앱 정보]에서 [테스트앱과 권한 동기화]를 눌러 다시 동기화할 수 있습니다.
카카오 플랫폼 이용 시 준수해야 할 사항은 개발자 웹사이트 하단의 서비스 약관과 운영 정책에서 확인할 수 있습니다. 이 외 자세한 사항은 각 제품 문서의 이용 정책을 함께 참고합니다.
카카오 플랫폼에서 제공하는 대부분의 API는 오픈 API로, 플랫폼 정책 범위 안에서 애플리케이션 등록을 통해 누구나 무료로 이용할 수 있습니다. 단, 원활한 서비스 제공을 위해 일정한 사용량 제한(이하 쿼터, Quota)이 적용됩니다. 현재 적용되는 쿼터 정보는 쿼터에서, 각 앱의 쿼터 소모량은 [내 애플리케이션] > [통계] > [쿼터]에서 각각 확인할 수 있습니다.
쿼터는 각 개발자 계정이 소유한 모든 앱의 쿼터 소모량을 합산하여 적용됩니다. 개발자 계정이 소유한 하나의 앱에서 특정 API의 쿼터를 초과할 경우, 다른 앱의 해당 API 이용이 제한될 수 있으므로 주의합니다.
각 API에 대해 적용되는 쿼터는 월간 제공량 및 일일 제공량 제한이 각각 존재하며, 해당 API의 기간별 요청 수를 기준으로 합니다. API 요청 수는 카카오 플랫폼에 정상적으로 전달되어 요청 수행 및 응답에 성공한 요청 1건당 1씩 집계(Count)됩니다. 번역, 음성, 포즈 API 중 일부 API의 쿼터는 문자나 프레임 수와 같은 API 요청에 따른 데이터 처리량을 기준으로 별도 집계됩니다.