문서     >   서비스    >    REST API

REST API


REST API


이 문서는 REST API를 사용한 KEYMESH API 사용법과 설정에 대하여 안내합니다.
기능 소개
KEYMESH API는 대부분의 기능을 REST API로 제공합니다. KEYMESH 서비스 UI와 관련 있는 플러그인 성격의 일부 기능을 제외하고 모든 기능을 서비스 서버에서 REST API로 구현할 수 있습니다. 
또한 KEYMESH SDK가 지원하지 않는 KEYMESH API는 REST API를 통해 사용 가능합니다.


API는 다양한 환경과 연동하여 사용할 수 있습니다. 


아파트 연동하기          사무실 연동하기         호텔 연동하기




[내 애플리케이션] > [플랫폼]에서 사이트 도메인을 비롯한 Web 플랫폼 정보를 입력할 수 있습니다. 자세한 안내는 플랫폼 등록을 참고합니다.
REST API 테스트 도구를 사용하여 간편하게 요청 및 응답 구성을 확인할 수 있습니다. 화면 구성 요소는 아래와 같습니다.


REST API 테스트 도구


개발자 웹사이트는 REST 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 프로토콜로만 호출 가능합니다. 이 외 개발 환경 요구 사양은 아래의 지원 버전 정보를 참고합니다.
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를 제외한 다른 브라우저의 최신 버전 사용 권장
플랫폼 설정

🅐 API 목록: 테스트할 API를 선택합니다.
🅑 앱 정보: REST API 요청을 보낼 대상 테스트 앱을 선택합니다. 예제인 [developers-sample]이 기본 설정돼 있으며, 앱 이름 옆의 목록 버튼을 눌러 사용자가 직접 등록한 앱으로 변경 가능합니다.
🅒 API 정보: 현재 선택한 API가 어떤 기능인지 설명합니다.
🅓 인증: 요청 헤더(Header)에 액세스 토큰과 앱 어드민 키 중 어떤 정보를 전달할 것인지 선택합니다. 액세스 토큰을 선택한 경우, [토큰 발급]을 누르면 현재 로그인한 카카오계정으로 테스트 앱의 액세스 토큰을 바로 발급 받을 수 있습니다.
🅔 Query String: 테스트 요청 시 전달할 파라미터 값을 직접 설정할 수 있습니다. 각 항목에 입력해야 하는 값의 내용이나 형식은 아래 요청 및 응답 정보에서 확인할 수 있습니다. [전송] 버튼을 눌러 입력한 내용대로 요청을 실행할 수 있습니다.


설치


JavaScript SDK 파일을 웹 페이지에 포함(Include)시킵니다. script 태그 내부에 버전과 해당 버전의 Integrity 값을 정확히 기입해야 합니다. SDK 다운로드에서 확인 및 복사할 수 있습니다. 
아래 예제를 참고합니다.
<script src="https://t1.kakaocdn.net/kakao_js_sdk/${VERSION}/kakao.min.js"
integrity="${INTEGRITY_VALUE}" crossorigin="anonymous"></script>
참고: JavaScript SDK 데모
[도구] 에서 JavaScript SDK의 기능 및 동작을 참고할 수 있는 데모를 제공합니다.
JS SDK 데모outlink

초기화


다운로드를 참고하여 JavaScript SDK를 웹 페이지에 포함한 후, 다음의 JavaScript SDK 초기화 함수를 호출합니다. JAVASCRIPT_KEY에 [내 애플리케이션] > [앱 키]에서 확인한 JavaScript 키를
 할당해야 합니다.
Kakao.init('JAVASCRIPT_KEY');
Kakao.isInitialized();
다음은 초기화 함수를 호출하고, 이어서 초기화가 잘 되었는지 확인하는 함수를 호출하는 예제입니다.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Kakao JavaScript SDK</title>
<script src="https://t1.kakaocdn.net/kakao_js_sdk/${VERSION}/kakao.min.js"
integrity="${INTEGRITY_VALUE}" crossorigin="anonymous"></script>
<script>
// SDK를 초기화 합니다. 사용할 앱의 JavaScript 키를 설정해야 합니다.
Kakao.init('JAVASCRIPT_KEY');

// SDK 초기화 여부를 판단합니다.
console.log(Kakao.isInitialized());
</script>
</head>
<body></body>
</html>
JavaScript SDK가 정상적으로 초기화된 상태라면, 해당 웹 페이지 실행 시 개발자 도구 콘솔에 true가 출력됩니다. false가 출력됐다면 초기화에 사용한 JavaScript 키 값이 올바른지 확인합니다.


사업자 등록번호 : 1238701244 | 대표 : 김도현
통신판매업 신고 번호 : 2022-서울서초-1333
Tel: 1833-6349 | Fax: 02-6919-1591
E-mail: support@thesesamelab.com
Address: 서울 구로구 디지털로 272 한신아이티타워 12층 1201호

Copyright ⓒ 2023 Sesame Lab All Rights Reserved