페이지 이동경로
  • 문서>
  • 이용 안내>
  • 튜토리얼

이용 안내

튜토리얼

이 문서는 카카오 API를 처음 사용하는 사용자에게 카카오 API를 호출하는 전반적인 과정을 설명합니다.

1. 로그인하기

카카오디벨로퍼스에서 개발자 계정으로 로그인합니다.

개발자 계정이 없는 경우, 카카오 계정으로 로그인 후 [회원가입]을 눌러 개발자 계정으로 등록할 수 있습니다.

2. 앱 만들기

카카오 API를 사용하려면 이 필요합니다. 앱이 없는 경우, 앱을 먼저 생성해야 합니다.


  1. [내 애플리케이션]에서 [애플리케이션 추가하기]를 누릅니다.
  2. 🅐 앱 아이콘에 로고나 아이콘을 등록합니다. 추후 기본 정보에서 수정할 수 있으니 생략해도 됩니다.
  3. 🅑 앱 이름에 서비스 이름을 입력합니다.
  4. 🅒 회사명에 서비스를 운영하는 사업자나 단체 이름을 입력합니다. 개인 개발자일 경우, 개발자 정보나 서비스 출처를 대표할 수 있는 이름을 입력해도 됩니다.
  5. 🅓 카테고리에서 서비스가 속한 분류를 선택합니다.
  6. 운영 정책에서 제한하는 사항에 해당하지 않는지 확인 후, 🅔 항목을 선택합니다.
  7. [저장]을 누르면 앱이 생성됩니다.
애플리케이션 추가 화면

3. 앱 키 확인하기

카카오 API 호출 시, 호출하는 앱을 인증하기 위해 인증 헤더에 앱 키를 전달해야 합니다.

[내 애플리케이션] > [앱 키]에서 앱의 앱 키를 확인할 수 있습니다. 사용하는 플랫폼이나 API에 따라 사용할 앱 키가 다릅니다. 각 API 개발 가이드에서 필요한 인증 방식을 안내합니다.

앱 키 조회 화면

4. API 호출하기

API를 쉽게 호출해보기 위해 선행 작업이 필요 없는 Daum 검색 API를 호출해 보겠습니다.

CURL 사용하기

개발 문서에서 안내한 대로 이 API는 REST API 키를 사용해야 합니다.

이전 단계에서 확인한 REST API 키를 요청 헤더로 전달합니다.

curl -v -G GET "https://dapi.kakao.com/v2/search/web" \
  --data-urlencode "query=카카오" \
  -H "Authorization: KakaoAK ${YOUR_REST_API_KEY}"

예를 들어, REST API 키가 6f95e7e3146********라면 아래와 같이 요청할 수 있습니다.

curl -v -G GET "https://dapi.kakao.com/v2/search/web" \
  --data-urlencode "query=카카오" \
  -H "Authorization: KakaoAK 6f95e7e3146********"
참고: 요청 예제를 어떻게 사용하나요?

REST API 문서의 요청 예제에서는 curl을 사용합니다. curl 예제는 각 운영 체제에서 지원하는 터미널(또는 명령 프롬프트)을 열어 실행할 수 있습니다.

REST API 테스트 도구 사용하기

카카오디벨로퍼스에서 제공하는 테스트 도구로도 카카오 API를 호출해볼 수 있습니다.


  1. REST API 테스트 도구에서 등록한 앱을 선택합니다. 초기값으로 선택되어 있는 developers-sample 앱을 사용해도 됩니다.
  2. 개발 문서에 안내된대로 파라미터를 입력한 후 [전송]을 선택합니다.

응답 결과와 함께 요청 코드 예시를 확인할 수 있습니다.

자세한 REST API 테스트 도구 사용법은 테스트 도구를 참고합니다.

5. 다른 API 호출하기

위와 같은 방법으로 카카오 API 플랫폼이 제공하는 다양한 API를 사용해볼 수 있습니다. API를 호출하려면 API마다 필요한 선행 작업을 마쳐야 합니다.

API 선행 작업 확인하기

개발 가이드 상단의 기본 정보 표에서 API 호출에 필요한 선행 작업을 안내합니다.

문서 기본 정보

기본 정보 표의 각 항목이 의미하는 바는 아래와 같습니다.

  • 메서드: API 요청 메서드
  • URL: API 요청을 보낼 엔드포인트
  • 인증 방식: API 호출에 필요한 인증 방식, 액세스 토큰 또는 앱 키, 비즈니스 토큰
  • 권한: API를 호출하기 위해 필요한 권한
  • 사전 설정: 해당 API를 호출하기 전, [내 애플리케이션]에서 설정해야 하는 항목을 안내합니다.
    • 사용 권한 신청: API 사용을 위한 권한이 필요한 경우 (예: 카카오모먼트, 카카오톡 캘린더 등)
    • 동의항목: 동의항목 설정 및 사용자가 동의가 필요한 경우, 동의항목 열에서 필요한 동의항목 이름 안내
    • 카카오싱크: 카카오싱크 도입 및 설정이 필요한 경우
  • 카카오 로그인: 해당 API를 연동하기 위해 카카오 로그인 기능을 구현해야 하는지 여부
  • 동의항목: 해당 API 또는 API에서 제공하는 기능을 위해 설정해야 하는 동의항목 이름