API Call Sequence

BECON Connect API를 사용하여 서비스를 개발하는 방법을 API 호출 흐름을 통해 설명합니다.

인증 토큰 발급

인증 토큰을 발급받는 과정을 설명합니다.

인증 토큰은 서비스에서 BECON Connect API를 호출할 때 필요한 값입니다. 발급받은 인증 토큰을 요청 헤더(request header)에 포함해야 BECON Connect API를 호출하여 사용할 수 있습니다. 

인증 토큰은 하루(24시간) 동안 유효합니다. 따라서 서비스는 인증 토큰의 유효 기간이 만료되기 전에 재발급 받아야 합니다.

인증 토큰 관련 API에 대한 더 자세한 내용은 API Reference > Auth 페이지를 참고하세요.

APIs to be used

• GET /tms/v1.0/connect/auth/servertime

• POST /tms/v1.0/connect/auth/token

Sequence

인증 토큰을 발급받기 위해서 먼저 간단한 시그니처 값을 생성해야 합니다. 이 값은 BECON Connect와 서비스 사이에 약속된 대칭키와 서버 시간 값을 특정 알고리즘으로 암호화한 값입니다.

1. 서버 시간 조회 API (GET /tms/v1.0/connect/auth/servertime)를 호출하여 시그니처 값 생성에 필요한 서버 시간 값을 얻습니다.

2. 대칭키와 서버 시간 값을 이용하여 시그니처 값을 생성합니다.

3. 생성한 시그니처 값을 이용하여 인증 토큰 생성 API (POST /tms/v1.0/connect/auth/token)를 호출합니다.

4. API를 통해 유효한 시그니처 값이 전달되었다면, 그 응답으로 인증 토큰을 전달받습니다.

 

 

공조 설비의 상태 조회

LG BECON Cloud 플랫폼에 등록된 LG 공조 설비의 상태를 조회하는 과정을 설명합니다.

상태 조회 관련 API에 대한 더 자세한 내용은 API Reference > Facility 페이지를 참고하세요.

APIs to be used

• GET /tms/v1.0/connect/site

• GET /tms/v1.0/connect/site/{site-code}/gw

• GET /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facilities

• GET /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facility/{facility_type}/{facility-id}/state

Sequence

1. 공조 설비의 상태를 조회하기 전에, 필요에 따라 현장 목록 조회 API (GET /tms/v1.0/connect/site)를 호출하여 현장 목록을 조회합니다.

2. 필요한 경우, GW 리스트 조회 API (GET /tms/v1.0/connect/site/{site-code}/gw)를 호출하여 특정 현장에 설치된 제어기(Gateway) 목록을 조회합니다.

3. 필요할 경우, 공조 설비 리스트 조회 API (GET /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facilities)를 호출하여 특정 제어기(gateway)에 설치된 공조 설비 목록을 조회합니다.

4. 상태 조회를 할 공조 설비를 정했다면, 해당 공조 설비의 상태조회 API (GET /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facility/{facility_type}/{facility-id}/state)를 호출합니다. 그 응답으로 해당 공조 설비의 상태 값을 전달받습니다.

 

 

공조 설비 제어

LG BECON Cloud 플랫폼에 등록된 LG 공조 설비를 제어하는 과정을 설명합니다.

제어 관련 API에 대한 더 자세한 내용은 API Reference > Control 페이지를 참고하세요.

APIs to be used

• PUT /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facility/{facility_type}

Sequence

1. 제어할 공조 설비에 제어 명령을 전달하기 위해 일반 제어 API (PUT /tms/v1.0/connect/site/{site-code}/gw/{gw-id}/facility/{facility_type})를 호출합니다.

2. API 응답으로 제어 명령 성공 여부를 반환받습니다.