페이지 이동경로
  • Docs>
  • REST API>
  • Getting started

REST API

Getting started

This document guides how to use the REST API provided by the Kakao API platform.

Before you begin

Overview

Most Kakao APIs are provided as a REST API, except for Kakao Talk Sharing or some plugin features related to service UI. Kakao APIs not supported by Kakao SDK are also available through a REST API.

REST API is available in any environment where HTTP request is possible. It is used to send requests from a client to a server or from a server to another server. Examples are below.

  • Mobile or PC web environment
  • Mobile environment such as iOS or Android
  • Web server in various environments such as Java, Ruby, or Python

Refer to Reference to check the request and response specifications.

Requirements

To use Kakao APIs through a REST API, the server and development environments must meet the following minimum versions.

Name Supported version
OS X Mavericks or higher
Windows Windows XP SP3 or higher
Java JRE 1.8.0_101 or higher
Browser Chrome 49 or higher
Firefox 50 or higher
Safari 10 or higher
Internet Explorer (IE) 9 or higher
Microsoft Edge 14 or higher
CentOS/RHEL ca-certificates-2015.2.4-65.0.1.el6_6.noarch or higher

* Notice: Replacing SSL certificates in Kakao Open API Platform

Platform

Go to [My Application] > [Platform] and enter the web platform information of the service. Refer to Platform.

Security: Allowed IP address

Caution

For services in operation, this setting may affect the functions that use the Kakao API. Be aware contents below before using this.

To prevent security incidents such as app key leakage, set the IP address to be allowed.

Go to [My Application] > [Allowed IP address] > [Register allowed IP address] and enter the service server's IP addresses to be allowed. Registering CIDR(IP/CIDR) or Subnet Mask(IP/Mask) information is recommended, but individual IP(IPv4, IPv6) is also supported. To register multiple IP addresses, separate them with line breaks.

How to register allowed IP address

Allowed IP address setting is applied to all Kakao API calls with the REST API key or the Admin key. After any IP address is registered, only REST API calls from the registered IP address will be allowed. If a request has been sent from an unregistered IP address, the following error is returned. To solve this issue, register the IP address of the server to send a request from, or disable this feature.

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

To disable this feature, delete all registered IP addresses by clicking [Delete].

Firewall and ACL

If access to the service server is restricted by the firewall or ACL (Access Control List), set the firewall rules or ACL to use Kakao API. To check the Kakao IP list, call Retrieve Kakao IP list.

Test tool

Kakao Developers provides a REST API test tool for testing and developing with a REST API or debugging.

Composition of REST API test tool

🅐 API List: Select one of the APIs to test 🅑 App: [developers-sample] is set as default, select another test app by clicking the list icon next to the app name 🅒 API information: Describes the feature of selected API 🅓 Authentication: Select an authentication method between an access token or the app's admin key, an access token will be issued when clicking [Issue token] 🅔 Parameter: Set the request parameter values and click [Send] to request

Specifications in REST API test tool

🅕 Request: Describes the request parameters of the selected API 🅖 Response: Describes the keys and values in response of selected API

Response example in REST API test tool

🅗 Response example: Shows the examples of the response

Response and request example in REST API test tool

🅘 HTTP status code: Shows the HTTP status code in response, refer to Response code 🅙 Response body: Shows the response body in response 🅚 Response code example: A request code example for a test in the actual development environment

Sample

REST API requests can be implemented with various programming languages. The examples are below.

Note: How to request samples of other languages

For reference or samples of other languages ​​and frameworks not provided in this documentation, search it or ask us in Devtalk.

REST API> Getting started