API Call Sequence

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

디바이스 상태 조회

사용자의 디바이스 상태를 조회하는 방법을 설명합니다.

APIs to Be Used 

• GET /devices
• GET /devices/{device-id}

Sequence 

1. 여러분의 서비스는 디바이스 목록 조회 API (GET/device)를 이용하여, LG ThinQ 플랫폼에 등록된 사용자의 디바이스 목록을 가져와야 합니다.
   이 과정은 처음 한 번만 수행하면 되고, 목록을 한 번 가져온 후에는 매번 수행할 필요는 없습니다. 
2. 디바이스 목록에서 상태를 조회할 디바이스의 device-id 값을 확인하고, 이 값을 이용하여 디바이스 상태 조회 API (GET/devices/{device-id})를 호출합니다.

 

디바이스 제어

사용자의 디바이스를 제어하는 방법을 설명합니다.

APIs to Be Used 

• GET /devices
• GET /devices/profile/{device-id}
• POST /devices/{device-id}

Sequence 

1. 여러분의 서비스는 디바이스 목록 조회 API (GET/devices)를 이용하여, LG ThinQ 플랫폼에 등록된 사용자의 디바이스 목록을 가져와야 합니다.
   이 과정은 처음 한 번만 수행하면 되고, 목록을 한 번 가져온 후에는 매번 수행할 필요는 없습니다.
2. 디바이스 목록에서 제어 대상 디바이스의 device-id 값을 확인하고, 이 값을 이용하여 디바이스 프로파일 조회 API (GET/devices/profile/{device-id})를 호출합니다. 
3. API 호출 응답으로 받은 디바이스 프로파일을 바탕으로 해당 디바이스에 대한 제어 명령을 생성합니다. 제어 명령은 디바이스 프로파일에서 제어를 원하는 속성을 찾아 name 과 value 쌍으로 표현합니다. 
4. device-id와 제어 명령을 이용하여, 디바이스 제어 API (POST/devices/{device-id})를 호출합니다. 
5. API 응답으로 디바이스 제어 결과를 반환 받습니다. 

 

디바이스의 이벤트 구독 

디바이스로부터 이벤트 메시지를 구독하는 방법을 설명합니다. 이벤트 메시지는 디바이스의 상태가 변경되는 경우 발생하며, 디바이스의 변경된 상태 정보를 담고 있습니다.

이벤트 메시지에 대한 상세 설명은 Event API > 이벤트 메시지 정의를 참고하십시오. 

APIs to Be Used 

• GET /devices
• POST /event/{device-id}

Sequence 

1. 여러분의 서비스는 디바이스 목록 조회 API (GET/device)를 이용하여, LG ThinQ 플랫폼에 등록된 사용자의 디바이스 목록을 가져와야 합니다.
   이 과정은 처음 한 번만 수행하면 되고, 목록을 한 번 가져온 후에는 매번 수행할 필요는 없습니다.
2. 디바이스 목록에서 이벤트를 구독할 디바이스에 대한 device-id 값을 확인하고, 이 값을 이용해 이벤트 등록 API (POST/event/{device-id})를 호출합니다. 
3. API 응답으로 이벤트 구독 성공/실패에 대한 결과를 반환 받습니다.
4. 디바이스의 상태가 변경되었을 때, 이벤트 메시지를 전달 받습니다.

디바이스의 푸쉬 알림 구독

디바이스의 푸쉬 알림을 구독하는 방법을 설명합니다. 

APIs to Be Used 

• GET /devices
• POST /push/{device-id}

Sequence 

1. 여러분의 서비스는 디바이스 목록 조회 API (GET/device)를 이용하여, LG ThinQ 플랫폼에 등록된 사용자의 디바이스 목록을 가져와야 합니다.
   이 과정은 처음 한 번만 수행하면 되고, 목록을 한 번 가져온 후에는 매번 수행할 필요는 없습니다.  
2. 디바이스 목록에서 푸쉬 알림을 받을 디바이스의 device-id 값을 확인하고, 이 값를 이용하여 디바이스 알림 구독 API (POST/push/{device-id})를 호출합니다. 
3. API 응답으로 구독 성공/실패에 대한 결과를 반환 받습니다.  
4. 디바이스로부터 푸쉬 알림이 발생하였을 때, 등록한 callback URL로 푸쉬 메시지를 전달 받습니다. 사용자에게 전달해야 하는 메시지가 있다면 적절히 처리합니다.