이 문서는 카카오 또는 공동체 서비스의 카카오 API 사용 과정을 설명합니다.

카카오 API를 사용하려면 카카오 및 공동체 내부의 사용자를 포함한 모든 사용자가 카카오디벨로퍼스의 개발자 계정으로 등록해야 합니다. 개발자 계정은 카카오디벨로퍼스 사이트에 카카오계정으로 로그인 후 [회원가입]을 선택해 등록할 수 있습니다.

카카오 및 공동체 사용자는 사내 계정(@kakaocorp.com, @kakaopaycorp.com, @kakaomobility.com 등)으로 개발자 계정을 등록해야 합니다. 사내 계정이 아닌 경우 앱 이름에 "카카오"나 "Kakao"를 포함한 단어를 사용할 수 없습니다.

특정 페이즈의 카카오 API 호출이 필요한 경우, 페이즈별 카카오디벨로퍼스에 개발자 계정과 앱을 각각 등록하고 해당 앱 정보로 API를 호출해야 합니다.

카카오 API의 페이즈 정보는 호스트별 페이즈에서 확인할 수 있습니다. 이외에 호스트, 호출 서비스, 제공 범위로 구분해 제공하는 카카오 API 종류에 대한 정보는 API 종류에서 확인할 수 있습니다.

개발자 계정은 카카오디벨로퍼스의 앱을 등록하고 관리하는 계정입니다. 앱의 관리 방법(멤버 추가, 역할 관리, 소유자 변경 등)은 멤버를 참고합니다.

개발자 계정 ID는 개발자 계정에 부여된 고유 ID입니다. 차이점은 아래를 참고합니다.

• 개발자 계정(developer_account): 카카오디벨로퍼스 로그인 시 사용하는 카카오계정, 이메일 형식
• 개발자 계정 ID(developer_id): 개발자 계정의 카카오계정 ID(account_id)당 부여된 고유 ID, 숫자 형식

카카오디벨로퍼스는 웹사이트와 함께 모바일 앱으로도 기능을 제공합니다. 자세한 내용은 웹사이트와 모바일 앱을 참고합니다.

카카오 API를 사용하려면 페이즈별 카카오디벨로퍼스의 앱 관리 페이지에서 앱을 등록해야 합니다. 서비스는 앱을 설정해서 카카오디벨로퍼스가 제공하는 다양한 기능을 사용할 수 있고, 플랫폼 키 또는 어드민 키로 카카오 API를 호출할 수 있습니다. 앱 설정 방법은 앱을 참고합니다.

앱 생성 시 아래 정보를 포함해야 합니다.

• 앱 아이콘: 디자인 예정인 경우라도 임시 아이콘으로 반드시 등록, 128*128 이하 크기 권장
• 앱 이름: 실제 서비스 이름으로 등록, 테스트 앱은 장애 또는 API 변경 시 빠른 대응을 위해 이름에 표시 권장
• 회사명: 서비스의 사업 소유권을 가진 사업자의 상호, 법인 또는 단체명(참고: 비즈니스 정보 등록하기)
• 카테고리: 앱이 제공할 서비스가 속한 분류 선택
• 앱 대표 도메인: 카카오디벨로퍼스 앱으로 제공할 서비스의 대표 도메인

앱 생성 후 조직 구성원의 개발자 계정을 멤버로 추가해 앱 관리 권한을 부여할 수 있습니다. 자세한 내용은 멤버를 참고합니다.

카카오 API 호출 시 아래 앱 정보를 확인 후 요청에 포함해야 합니다. 각 페이즈에 해당하는 앱 정보를 포함해야 합니다.

• 앱 ID: [서비스] API플랫폼 아지트에서 문의 시 사용, 앱 관리 페이지의 상단에서 확인
• 앱 키: 카카오 API 호출 시 사용, 앱 관리 페이지의 [앱] > [플랫폼 키] 또는 [어드민 키]에서 확인

실제 서비스를 위한 리얼 페이즈 앱은 1개로 제한합니다. 카카오 API(카카오 로그인, 카카오톡 공유 등)를 사용하고 있어 앱이 이미 등록돼 있는 경우, 새로운 앱을 등록하지 않고 기존 앱을 사용해야 합니다. 테스트용 앱을 추가 생성할 경우, 앱 이름으로 서비스용 앱과 구분할 수 있도록 해야 합니다.

카카오 또는 공동체 서비스의 앱은 추가 권한이 부여된 앱 타입을 가질 수 있습니다. 앱 생성 후 [서비스] API플랫폼 아지트에서 인하우스 앱 또는 공동체 앱으로 변경 요청합니다. (카카오디벨로퍼스에서 직접 변경 불가)

카카오 및 공동체의 서비스라도 카카오 로그인을 사용하지 않으며, 아래 조건을 만족하는 서비스의 경우 앱 타입을 변경할 필요가 없습니다.

• 회원 가입 및 탈퇴 기능 없음
• 자체적인 사용자 인증 방식 사용
• 카카오계정 직접 연동 방식 사용

통합 이전 제휴 API 시스템의 클라이언트 ID(Client ID)를 사용하는 앱을 카카오 API 플랫폼으로 전환하려면 [서비스] API플랫폼 아지트로 문의합니다.

앱 관리 페이지의 [앱] > [일반] > [비즈니스 정보]에 비즈니스 정보를 등록해 비즈 앱으로 전환할 수 있습니다.

카카오 또는 공동체 서비스의 비즈니스 정보는 아래 기본 규칙을 준수해 등록해야 합니다. 사업자 정보를 등록할 수 없는 경우 [서비스] API플랫폼 아지트로 문의합니다.

• 카카오 서비스
  • 회사명: "Kakao Corp." 로 입력
  • 사업자등록번호: 카카오의 사업자등록번호 입력
• 공동체 서비스
  • 회사명: 상호, 법인 또는 단체명(예: (주) 카카오엔터프라이즈) 입력
  • 사업자등록번호: 해당 공동체의 사업자등록번호 입력

카카오 API를 사용한 개발 관련 정보를 안내합니다. 카카오 API를 처음 사용하는 카카오 및 공동체 사용자에게 필요한 정보는 카카오 API 개요에서 확인할 수 있습니다.

REST API 또는 Kakao SDK로 사용할 수 있는 카카오 API의 개발 환경별 시작하기 문서입니다.

• REST API
• JavaScript
• Android
• iOS
• Flutter

테스트 환경을 위한 별도 앱이 필요한 경우, 테스트 앱을 사용합니다. 테스트 앱을 사용해 실제 서비스 적용 전 개발 환경에서 카카오 API 동작을 미리 확인할 수 있습니다.

앱 관리 페이지의 [통계]에서 각 앱의 API 통계를 제공합니다. 현재 로그인한 사용자가 멤버로 설정돼 있어 조회 및 관리할 수 있는 앱의 통계 정보만 확인할 수 있습니다. 자세한 정보는 통계를 참고합니다.

카카오 API 플랫폼 시스템 분석 도구인 Capri Cave는 카카오디벨로퍼스 통계보다 자세한 통계 정보를 제공합니다. Capri Cave와 관련된 자세한 정보는 통계를 참고합니다.

카카오디벨로퍼스의 API 및 앱 정보는 통합 API 어드민으로 조회하거나 관리할 수 있습니다. 통합 API 어드민에서는 앱 정보 조회, API 쿼터 확인, 사용자 검색과 같은 관리자 기능을 제공합니다. 이밖에 회원번호(app_user_id), 카카오계정 ID(account_id), 카카오톡 회원번호(talk_id, talk_user_id)를 다른 ID로 변환해주는 ID 변환기와 같은 편의 기능도 사용할 수 있습니다.

각 API를 제공하는 부서는 통합 API 플랫폼에 API를 등록한 후, [서비스] API플랫폼 아지트에서 통합 API 어드민 이용 권한을 신청합니다.

카카오디벨로퍼스는 서비스에 중대한 영향을 끼치는 설정 변경, 쿼터 소진, 정산 안내 등 주요 변경 사항이나 에러가 발생할 경우, 앱의 멤버에게 전송 가능한 아래 알림 수단을 지원합니다.

• 이메일
• 카카오디벨로퍼스 웹사이트 알림
• 카카오디벨로퍼스 카카오톡 공식 채널: Kakao Developers
• 와치 센터: 앱에 연결된 와치 센터 ID는 앱 관리 페이지의 [앱] > [고급] > [와치 센터 알림]에서 확인 및 수정 가능

카카오디벨로퍼스는 간편한 개발 환경을 제공하기 위해 다양한 기능의 도구를 제공합니다. [도구]에서 아래 항목을 포함한 다양한 기능을 확인하고 활용할 수 있습니다.

• REST API 테스트
• 웹훅 테스트
• 사용자 정의 템플릿