페이지 이동경로
  • 문서>
  • 시작하기>
  • REST API

시작하기

REST API

이 문서는 REST API를 사용한 카카오 API 사용법과 카카오디벨로퍼스(Kakao Developers, 이하 개발자 웹사이트) 설정에 대하여 안내합니다.

기능 소개

카카오 API는 대부분의 기능을 REST API로 제공합니다. 카카오톡 공유나 서비스 UI와 관련 있는 플러그인 성격의 일부 기능을 제외하고 모든 기능을 서비스 서버에서 REST API로 구현할 수 있습니다. 또한 카카오 SDK가 지원하지 않는 카카오 API는 REST API를 통해 사용 가능합니다.

REST API는 HTTP 요청을 보낼 수 있는 환경이라면 어디서든 이용 가능합니다. 클라이언트에서 서버로, 또는 서버에서 서버로 요청을 보낼 수 있습니다. 예를 들면 다음과 같은 환경에서 REST API를 사용할 수 있습니다.

  • 모바일/PC 웹 환경
  • iOS, Android 등 모바일 환경
  • Java, Ruby, Python 등 다양한 환경의 웹 서버

REST API 요청과 응답 규격을 비롯한 자세한 정보는 REST API 레퍼런스에서 확인할 수 있습니다.

요구 사양

카카오 플랫폼이 제공하는 REST API는 SSL(Secure Sockets Layer)이 적용된 HTTPS 프로토콜로만 호출 가능합니다. 이 외 개발 환경 요구 사양은 아래의 지원 버전 정보를 참고합니다.

Name Version
OS X Mavericks 이상
Windows Windows XP SP3 이상
Java JRE 1.8.0_101 이상
브라우저 Chrome 49 이상
Firefox 50 이상
Safari 10 이상
IE(Internet Explorer) 9 이상
Edge 14 이상
CentOS/RHEL ca-certificates-2015.2.4-65.0.1.el6_6.noarch 등

* 참고: 카카오 Open API 플랫폼 SSL 인증서 변경

* IE를 제외한 다른 브라우저의 최신 버전 사용 권장

플랫폼 설정

[내 애플리케이션] > [플랫폼]에서 사이트 도메인을 비롯한 Web 플랫폼 정보를 입력할 수 있습니다. 자세한 안내는 플랫폼 등록을 참고합니다.

REST API 테스트 도구

개발자 웹사이트는 REST API를 개발하고 디버깅할 때 유용한 REST API 테스트 도구를 제공합니다.

curl을 이용한 테스트

REST API는 REST API 테스트 도구 외에 curl을 이용하여 테스트해볼 수 있습니다. macOS에는 일반적으로 curl이 기본 탑재돼 있어 별도 설치가 필요하지 않지만, Windows PC에서 테스트하려면 curl을 설치해야 합니다.

REST API 테스트 도구를 사용하여 간편하게 요청 및 응답 구성을 확인할 수 있습니다. 화면 구성 요소는 아래와 같습니다.

REST API 테스트 도구 화면 상세 첫 번째

🅐 API 목록: 테스트할 API를 선택합니다.

🅑 앱 정보: REST API 요청을 보낼 대상 테스트 앱을 선택합니다. 예제인 [developers-sample]이 기본 설정돼 있으며, 앱 이름 옆의 목록 버튼을 눌러 사용자가 직접 등록한 앱으로 변경 가능합니다.

🅒 API 정보: 현재 선택한 API가 어떤 기능인지 설명합니다.

🅓 인증: 요청 헤더(Header)에 액세스 토큰과 앱 어드민 키 중 어떤 정보를 전달할 것인지 선택합니다. 액세스 토큰을 선택한 경우, [토큰 발급]을 누르면 현재 로그인한 카카오계정으로 테스트 앱의 액세스 토큰을 바로 발급 받을 수 있습니다.

🅔 Query String: 테스트 요청 시 전달할 파라미터 값을 직접 설정할 수 있습니다. 각 항목에 입력해야 하는 값의 내용이나 형식은 아래 요청 및 응답 정보에서 확인할 수 있습니다. [전송] 버튼을 눌러 입력한 내용대로 요청을 실행할 수 있습니다.

REST API 테스트 도구 화면 상세 두 번째

🅕 요청: 현재 선택한 API의 파라미터에 대한 설명입니다.

🅖 응답: API 요청 결과로 받는 응답의 구성 요소를 설명합니다.

REST API 테스트 도구 화면 상세 세 번째

🅗 응답 예제: 응답 및 에러가 어떤 형식과 구성으로 제공되는지 참고할 수 있도록 제공되는 기본 응답 예제입니다.

🅔 파라미터: [전송] 버튼을 눌러 테스트 요청을 실행할 수 있습니다. 요청 결과 화면은 응답 결과와 함께 사용자가 직접 커맨드(Command) 또는 터미널(Terminal)에서 전송해 볼 수 있는 요청 예제를 제공합니다. 요청 결과 화면의 구성 요소는 다음과 같습니다.

REST API 테스트 도구 화면 상세 응답 정보

🅘 HTTP 상태 코드(Status code): API 요청 결과로 받은 응답의 HTTP 상태 코드입니다. 자세한 정보는 응답 코드에서 확인할 수 있습니다.

🅙 응답 본문(Body): API 요청 결과로 받은 응답 본문입니다.

🅚 요청 코드 예시: 사용자의 개발 환경에서 직접 요청해 보는 데 사용할 수 있는 예제입니다.

참고 예제

다양한 프로그래밍 언어로 REST API 요청과 응답 처리를 구현할 수 있습니다. 다음은 REST API를 사용하는 언어별 참고 예제입니다.

예제 추가 요청 방법

이 문서에서 제공하지 않는 다른 언어 및 프레임워크(Framework)의 참고 자료나 예제는 데브톡에서 검색 또는 문의합니다.

보안: 허용 IP 주소

앱 키 유출과 같은 보안 사고에 대비하여, 카카오 API 서버가 등록된 IP 주소의 요청만 허용하도록 설정하는 기능입니다. [내 애플리케이션] > [허용 IP 주소]에서 설정할 수 있습니다.

허용 IP 주소 설정 화면

해당 기능을 사용하려면 [허용 IP 주소 등록] 버튼을 눌러 서비스 서버의 IP 주소를 입력하고 [저장]을 누릅니다. 이 기능은 REST API 키 혹은 어드민 키를 사용하는 모든 카카오 API 호출에 적용되며 IP(IPv4, IPv6), CIDR(IP/CIDR), Subnet Mask(IP/Mask)를 지원합니다. 줄바꿈으로 여러 개의 IP를 추가할 수 있습니다.

허용 IP 등록 기능을 더 이상 사용하지 않으려면 [삭제] 버튼을 눌러 등록된 IP 주소 목록을 삭제합니다. 등록된 허용 IP 주소가 하나도 없으면 기능이 비활성화됩니다.

IP 주소를 등록한 후에는 등록된 IP 주소에서만 REST API 키 혹은 어드민 키로 카카오 API를 호출할 수 있습니다. 등록되지 않은 IP 주소에서 카카오 API 요청 시 아래와 같이 에러 응답을 받습니다. 문제를 해결하려면 요청을 보낸 서비스 서버의 IP 주소를 추가 등록하거나, 허용 IP 등록 기능을 비활성화해야 합니다.

"msg": "ip mismatched! callerIp=XXX.XXX.XXX.XXX. check out registered ips.",
"code": -401