Quick reference

For all REST API HTTP request, use HTTPS under SSL environment. For login, REST API key is needed, all API request after login nees a token obtained from login.

REST API

All of the REST API functionality are mentioned below.


User management
URL HOST METHOD Functionality
/oauth/authorize https://kauth.kakao.com GET Login-obtain code
/oauth/token https://kauth.kakao.com POST Login-Obtain code, Login-Token renewal
/v1/user/logout https://kapi.kakao.com POST Logout
/v1/user/signup https://kapi.kakao.com POST Linking App
/v1/user/unlink https://kapi.kakao.com POST Disconnect APP
/v1/user/me https://kapi.kakao.com GET/POST Request user information
/v1/user/update_profile https://kapi.kakao.com POST Saving user information
/v1/user/ids https://kapi.kakao.com GET/POST user ID list request
/v1/user/access_token_info https://kapi.kakao.com GET validate and get information from user access token


Kakao Story
URL HOST METHOD 기능
/v1/api/story/isstoryuser https://kapi.kakao.com GET Confirm user
/v1/api/story/profile https://kapi.kakao.com GET Profile request
/v1/api/story/post/note https://kapi.kakao.com POST Post article
/v1/api/story/upload/multi https://kapi.kakao.com POST Upload photo
/v1/api/story/post/photo https://kapi.kakao.com POST Photo posting
/v1/api/story/linkinfo https://kapi.kakao.com GET Retrieve link information
/v1/api/story/post/link https://kapi.kakao.com POST Link posting
/v1/api/story/mystory https://kapi.kakao.com GET Request single mystory information
/v1/api/story/mystories https://kapi.kakao.com GET Request multiple mystory information
/v1/api/story/delete/mystory https://kapi.kakao.com DELETE Delete mystory


Kakao Talk
URL HOST METHOD Functionality
/v1/api/talk/profile https://kapi.kakao.com GET Profile request


Push notification
URL HOST METHOD Functionality
/v1/push/register https://kapi.kakao.com POST Register push token
/v1/push/tokens https://kapi.kakao.com GET Lookup register push token
/v1/push/deregister https://kapi.kakao.com POST Delete push token
/v1/push/send https://kapi.kakao.com POST Send push notification


URL HOST METHOD 기능
/v2/search/web https://apis.daum.net GET Search web contents
/v2/search/vclip https://apis.daum.net GET Search video clips
/v2/search/image https://apis.daum.net GET Search images
/v2/search/blog https://apis.daum.net GET Search blogs
/v2/search/knowledge https://apis.daum.net GET Search tips
/v3/search/book https://apis.daum.net GET Search Books
/v2/search/cafe https://apis.daum.net GET Search cafes


Daum Local
URL HOST METHOD 기능
/v2/local/search/address.{format} https://apis.daum.net GET Search an address
/v2/local/geo/coord2regioncode.{format} https://apis.daum.net GET Transform a coord into a region
/v2/local/geo/coord2address.{format} https://apis.daum.net GET Transform a coord into a address
/v2/local/geo/transcoord.{format} https://apis.daum.net GET Transform a coord
/v2/local/search/keyword.{format} https://apis.daum.net GET Search the place by a keyword
/v2/local/search/category.{format} https://apis.daum.net GET Search the place by a category
Vision
URL HOST METHOD 기능
/v1/vision/face/detect https://kapi.kakao.com POST 얼굴 검출
/v1/vision/product/detect https://kapi.kakao.com POST 상품 검출
/v1/vision/thumbnail/detect https://kapi.kakao.com POST 썸네일 검출
/v1/vision/thumbnail/crop https://kapi.kakao.com POST 썸네일 생성
/v1/vision/multitag/generate https://kapi.kakao.com POST 멀티태그 생성
/v1/vision/adult/detect https://kapi.kakao.com POST 성인이미지 판별
Translation
URL HOST METHOD 기능
/v1/translation/translate https://kapi.kakao.com GET, POST 문장 번역
Friends
URL HOST METHOD 기능
/v1/friends https://kapi.kakao.com GET 친구목록 조회

Response code

Through REST API call, various error code exist depending on status code of HTTP and run result.

HTTP Status code

Following is a response HTTP status code. In most of the requests, HTTP status code and response body is included HTTP. When request fails, refer response body's error code.

Status code description additional
200 Success Response body can defer by API
400 Failure General error. Mainly related to required parameter for API
401 Failure Authentication error. Usually user token related
403 Failure Permission error
500 Failure System error
502 Failure System error
503 Failure Checking on service

Individual successful call may differ in format for response body by each and every API. As such, please refer to details on each API.

Error code

When call fails, HTTP status code and error code with reasons behind failure will be returned in JSON format .

Detail code

Following is an error code definition. Values are all represented in negative values.

code description HTTP status code
-1 Internal error. When this is not specifically defined in error code 400
-2 Wrong parameter. When parameter for the call is wrongly made or required parameter is not included 400
-3 API call made to unsupported service. Also when API has been turned off from setting of the app running the API 400
-4 Account has been baned for API to be used 400
-5 Does not have permission on the specific API which is being called upon. 403
-10 Exceed the number of request possible. For details, refer to quota and limitation 400
-101 When request is made with out app being linked to service. In login based API cases, linking to the APP itself must be made priorly 400
-102 When user makes re-link attempts to the app whe he or she have already registered through app 400
-103 Call made with kakao account not in existence 400
-201 Wrong parameter structured when user management API call is made. Usually occurs when parameter does not match developer website user information's settings(My application > settings > user management) 400
-301 Call is made to unregistered appkey request or app that does not exist 400
-401 When user token has problems with it. This usually occur when call is made using expired token 401
-402 When user did not agree on permission for the API to use. 403
-403 등록되지 않은 사이트에서의 API 호출이 있을 경우 403
-501 When user who have not registered for Kakao Talk calls kakao talk API 400
-601 When user who have not registered for Kakao Story calls kakao talk API 400
-602 Exceed Kakao story image size while uploading it(10MB in size) 400
-603 Time out has occured while requesting upload/scrap information 400
-604 When scrap fails in kakaostory 400
-605 Requesting mystory in KakaoStory that does not exists 400
-606 Exceeding number of image(at max 5. for gif one file at max) while uploading kakaostory image. 400
-701 결제인증이 완료되지 않았는데 결제승인 API를 호출한 경우 400
-702 이미 결제 완료된 TID로 다시 결제승인 API를 호출한 경우 400
-703 결제승인 API 호출 시 포인트 금액이 잘못된 경우 400
-704 결제승인 API 호출 시 원결제수단(머니/카드)의 금액이 잘못된 경우 400
-705 결제승인 API 호출 시 지원하지 않는 결제수단으로 요청한 경우 400
-706 결제준비 API에서 요청한 partner_order_id 와 다른 값으로 결제승인 API 호출 한 경우 400
-707 결제준비 API에서 요청한 partner_user_id 와 다른 값으로 결제승인 API 호출 한 경우 400
-708 잘못된 pg_token 로 결제승인 API를 호출한 경우 400
-710 결제취소 API 호출 시 취소 요청 금액을 취소 가능액보다 큰 금액으로 요청한 경우 400
-721 TID가 존재하지 않는 경우 400
-722 금액 정보가 잘못된 경우 400
-723 결제 만료 시간이 지난 경우 400
-724 단건결제금액이 잘못된 경우 400
-725 총 결제금액이 잘못된 경우 400
-726 주문정보가 잘못된 경우 400
-730 가맹점 앱 정보가 잘못된 경우 400
-731 CID 가 잘못된 경우 400
-732 GID 가 잘못된 경우 400
-750 SID가 존재하지 않는 경우 400
-751 비활성화된 SID로 정기결제 API 를 호출한 경우 400
-752 SID가 월 최대 사용 횟수를 초과한 경우 400
-753 정기결제 API 호출시 partner_user_id가 SID를 발급받았던 최초 결제준비 API 에서 요청한 값과 다른 경우 400
-761 입력한 전화번호가 카카오톡에 가입하지 않은 경우 400
-780 결제승인 API 호출이 실패한 경우 500
-781 결제취소 API 호출이 실패한 경우 500
-782 정기결제 API 호출이 실패한 경우 500
-783 승인요청을 할 수 없는 상태에 결제승인 API를 호출한 경우 400
-784 취소요청을 할 수 없는 상태에 결제취소 API를 호출한 경우 400
-798 허용되지 않는 ip를 사용한 경우 400
-799 등록된 웹사이트 도메인의 설정과 요청 도메인이 다를 경우. 해당 서비스(앱/웹)의 사이트 도메인 설정이 필요합니다. 개발자 웹사이트내의 [내 애플리케이션]-[설정]-[일반]-[플랫폼]-[웹]의 설정을 살펴보세요. 400
-802 카카오톡 링크 사용시 등록된 웹사이트 도메인의 설정과 메시지내의 도메인이 다를 경우. 해당 서비스(앱/웹)의 사이트 도메인 설정이 필요합니다. 개발자 웹사이트내의 [내 애플리케이션]-[설정]-[일반]-[플랫폼]-[웹]의 설정을 살펴보세요. 400
-803 등록된 웹사이트 도메인 설정이 없는 경우. 해당 서비스(앱/웹)의 사이트 도메인 설정이 필요합니다. 개발자 웹사이트내의 [내 애플리케이션]-[설정]-[일반]-[플랫폼]-[웹]의 설정을 살펴보세요. 400
-901 Sending push message to device without registered push token 400
-9798 Under service maintenance 503
Example

Following is a failure in request and example of error code. For code it will be a Integer type, and for msg, it's a String type.

  • When number of API exceed
{
  "code":-10,
  "msg":"API limit has been exceeded."
}
  • Whenre there is a problem with user token
{
  "code":-401,
  "msg":"InvalidTokenException"
}

For code values there is no strict rule upon it, and for msg values, unless the meaning of it changes, the content of message can be changed.


Last Modified : 2019-11-05