Overview
여러분의 서비스가 LG BECON Cloud 플랫폼에 연결된 LG 공조 설비의 정보를 얻고, 제어하려면 어떻게 해야 할까요?
LG BECON Cloud 플랫폼은 파트너의 공조 설비 제어 및 유지관리 서비스를 위한 인터페이스로 BECON Connect API를 제공합니다.
What is BECON Connect?
BECON Connect는 LG BECON Cloud 플랫폼이 파트너에게 제공하는 인터페이스로, 현장(빌딩)에 설치된 LG 공조 설비 제어와 유지관리 서비스를 직접 운영하고자 하는 파트너를 위해 제공되는 Cloud-to-Cloud 인터페이스입니다. BECON Connect API (Application Programming Interface)는 RESTful API로 디자인되었으며, 다음 기능을 제공합니다.
- LG 공조 설비 제어
- LG 공조 설비 상태 조회
- LG 공조 설비의 상태 변경에 대한 이벤트 구독(푸시 메시지 수신)
Basic Concept
BECON Connect 서비스의 구조를 간략하게 설명하는 그림입니다.
여러분의 서비스 서버와 LG BECON Cloud는 BECON Connect API를 통해 현장에 설치된 LG 공조 설비들의 데이터를 받고, 제어할 수 있습니다.
여러분의 서비스는 BECON Connect API를 호출하여 다음과 같은 일들을 할 수 있습니다.
- LG BECON Cloud 플랫폼에 등록된 현장의 공조 설비 리스트를 조회합니다.
- 특정 공조 설비의 상태 값을 읽어, 해당 설비의 상태 정보를 얻습니다.
- 특정 공조 설비의 상태 값을 변경하여, 해당 설비로 제어 명령을 전달합니다.
- 특정 공조 설비의 상태 값에 대한 변경 알림을 수신하여, 변경을 감지할 수 있습니다.
Terms and Definitions
BECON Connect API에서 사용하는 용어의 정의는 다음과 같습니다.
|
Terms |
Description |
|---|---|
|
BECON Connect |
LG 공조 설비와 연동하여 제어 및 유지관리 서비스를 직접 운영하는 파트너를 위해 LG BECON Cloud 플랫폼이 제공하는 인터페이스입니다. 파트너 서비스가 LG BECON Cloud 플랫폼에 연결된 다양한 LG 공조 설비들과 통신할 수 있도록 해주는 Cloud-to-Cloud 클라우드 인터페이스입니다. |
|
BECON Connect API |
BECON Connect가 제공하는 API (Application Programming Interface)입니다. RESTful 패턴으로 사용하기 쉽게 설계되었으며, 다음 기능을 제공합니다.
|
|
파트너 서버 |
파트너가 서비스를 운영하고 있는 서버입니다. |
|
서비스 |
파트너 서버에서 운영되는 파트너의 서비스를 말하며, BECON Connect API를 사용하여 개발됩니다. 파트너십이 이루어지면 LG 담당자는 서비스를 생성하여 서비스 고유값(SERVICE_CONFIG)을 발급합니다. 파트너는 이 값을 BECON Connect API 호출 시, 요청 헤더에 입력하여 API 사용 허가를 얻고 서비스를 개발합니다. |
|
사용자 (END-User) |
파트너 서비스의 사용자이자, LG 공조 설비를 사용하는 고객입니다.
|
|
공조 설비 |
실내 공간의 온도, 습도 및 공기 정화를 조절하여 적절한 조건으로 유지하는 설비입니다. BECON Connect에서는 LG BECON Cloud 플랫폼에 등록된 사용자의 "LG 공조 설비"를 의미합니다. 공조 설비 등록은 사용자가 계약한 유지관리 업체의 설치 기사님에 의해 진행됩니다.
|
|
SERVICE_CONFIG
|
BECON Connect가 파트너의 서비스를 식별하고, BECON Connect API 사용을 허가해주기 위한 서비스 고유 정보입니다. SERVICE_CONFIG는 service_id와 service_key를 포함합니다.
|
|
DEV_SERVICE_CONFIG |
파트너의 서비스를 BECON Cloud 플랫폼의 개발 형상 서버(STAGE)와 연동하는 SERVICE_CONFIG입니다. 서비스 개발 단계에서 사용합니다. |
|
PRODUCT_SERVICE_CONFIG |
파트너의 서비스를 BECON Cloud 플랫폼의 운영 형상 서버(PRD)와 연동하는 SERVICE_CONFIG입니다. 서비스 배포 시, 이 값을 사용합니다. |
How to Develop your Service?
파트너십을 맺은 후 서비스를 배포하기까지의 과정은 다음과 같습니다.
1. 파트너십 요청
ThinQ Connect API 정보는 공개되어 있지만, 이를 사용하려면 LG전자와 파트너십을 맺은 후 서비스 키를 요청하고 발급받아야 합니다.
2. 서비스 생성
서비스 생성을 요청하십시오. 서비스 생성이 완료되면 LG 담당자가 서비스 어드민에게 DEV_SERVICE_CONFIG를 발급합니다.
요청 절차
- 요청서 다운로드 및 내용 작성
- 작성한 요청서를 cloud-sdt-tms@lge.com으로 발송
- 서비스 어드민: 파트너사의 임직원으로 서비스마다 1명씩 지정됩니다. 기본적으로 서비스 생성을 요청한 사람을 서비스 어드민으로 지정하며, 향후 변경할 수 있습니다.
- DEV_SERVICE_CONFIG: 서비스 고유값(service_id, service_key)으로, 서비스를 식별하여 BECON Cloud 플랫폼의 개발 형상 서버들과 연동할 수 있게 해줍니다.
3. 서비스 개발
BECON Connect API와 연동하여 서비스를 개발하십시오.
BECON Connect API를 호출할 때는 API 요청 헤더에 다음을 입력해야 합니다.
|
헤더 파라미터 |
입력값 |
설명 |
|---|---|---|
x-lgtms-service-id |
LG 담당자에게 발급받은 SERVICE_CONFIG 중, service_id 값 |
이 정보로 여러분의 서비스를 식별하고, 허가받은 서비스인지를 확인합니다. |
x-lgtms-service-key |
LG 담당자에게 발급받은 SERVICE_CONFIG 중, service_key 값 |
이 정보로 여러분의 서비스를 식별하고, 허가받은 서비스인지를 확인합니다. |
x-lgtms-service-token |
LG BECON Connect로 발급받은 인증 토큰값 |
service_id와 service_key 값을 사용하여 BECON Connect에서 발급받는 토큰 값입니다.
|
BECON Connect API를 사용하여 다음과 같은 기능들을 개발할 수 있습니다.
- LG 공조 설비 제어
- LG 공조 설비 상태 조회
- LG 공조 설비의 상태 변경 값 구독
4. 서비스 인증
서비스 개발이 완료되면 서비스 인증을 요청하십시오. LG 담당자가 인증을 완료하면 서비스 어드민에게 PRODUCT_SERVICE_CONFIG를 발급합니다. 배포 버전의 서비스에서는 이 값으로 BECON Connect API를 호출해야 합니다.
요청 절차
- 요청서 다운로드 및 내용 작성
- 작성한 요청서를 cloud-sdt-tms@lge.com으로 발송
- PRODUCT_SERVICE_CONFIG: 서비스 고유값(service_id, service_key)으로, 서비스를 식별하여 BECON Cloud 플랫폼의 운영 형상 서버들과 연동할 수 있게 해줍니다.