API

Kakao. API

카카오 API와 관련된 함수들이 포함되어 있습니다.

각 API에 대한 요청 파라미터와 응답은 REST API와 동일합니다. REST API 레퍼런스

Methods

(static) cleanup()

API를 호출하기 위해 사용한 리소스를 해제합니다.

(static) request(settings) → {Promise}

See:

카카오 API를 호출할 수 있습니다.

Example
// 사용자 정보 가져오기
Kakao.API.request({
  url: '/v2/user/me',
  success: function(res) {
    console.log(res)
  },
  fail: function(error) {
    console.error(error)
  }
})
Parameters:
Name Type Description
settings Object

API 호출과 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Description
url APIUrl

호출할 API URL

data Object <optional>

API에 전달할 파라미터

files FileList | Array.<File> | Array.<Blob> <optional>

파일 첨부가 필요한 API에서 이용하는 파일 파라미터

success function <optional>

API 호출이 성공할 경우 결과를 받을 콜백 함수

fail function <optional>

API 호출이 실패할 경우 결과를 받을 콜백 함수

always function <optional>

API 호출이 성공하거나 실패할 경우 항상 호출할 콜백 함수

Returns:
Type
Promise

Type Definitions

APIUrl

호스트가 https://dapi.kakao.com인 API (검색, 로컬, 비전, 번역)는 제외되며, Ajax를 통해 직접 요청할 수 있습니다. Admin 키를 사용하는 API (인증, 푸시, 페이)는 제외됩니다. 푸시 알림 기능은 지원되지 않습니다.

Type:
  • String