Overview

LG 세탁기/건조기 제품으로 상업용 세탁 서비스를 운영하고 싶으신가요? LG ThinQ 플랫폼은 이러한 서비스를 운영하는 파트너를 위해 Commercial Laundry API를 제공합니다.

What is Commercial Laundry API?

상업용 세탁 서비스는 호텔, 기숙사, 코인 빨래방 등과 같은 곳에서 셀프서비스로 운영되는 빨래방을 위한 서비스입니다. LG 디바이스(세탁기/건조기)로 이 서비스를 운영하고자 하는 파트너를 위해, ThinQ 플랫폼은 파트너의 서비스 서버와 LG 서버가 연동할 수 있는 Cloud-to-Cloud 인터페이스를 제공합니다. 이 인터페이스는 RESTful API로 설계되었으며, 이를 Commercial Laundry API라고 정의합니다.

파트너는 Commercial Laundry API를 통해 다음과 같은 작업을 할 수 있습니다.

LG 디바이스(세탁기/건조기) 정보를 원격으로 조회합니다.
LG 디바이스(세탁기/건조기)를 원격으로 설정하고 관리합니다.
LG 디바이스(세탁기/건조기) 사용 이력에 대한 다양한 통계 데이터를 조회합니다.

Basic Concept

상업용 세탁 서비스의 구조를 간략하게 설명하는 그림입니다. 여러분의 서비스는 Commercial Laundry API를 통해 LG 디바이스에 대한 작업을 ThinQ 서버에 요청하고, ThinQ 서버는 LG 디바이스와 상호 작용하여 작업을 수행한 후 그 결과를 다시 여러분의 서비스로 전달합니다.

상업용 세탁 서비스에 대한 간략한 아키텍처

여러분은 크게 2가지 작업을 해야 합니다.

디바이스를 ThinQ 플랫폼에 등록하기 (LG Installer App 이용)

LG가 제공하는 Installer App을 통해, 스토어에 설치된 LG 디바이스를 ThinQ 플랫폼에 등록하십시오.

LG Installer App은 파트너 계약 체결 후 LG 담당자가 개별적으로 제공합니다. 제공받지 못한 경우 Support > Technical Q&A 혹은 bizdev@lge.com으로 연락주시기 바랍니다.

서비스 개발하기 (Commercial Laundry API 이용)

Commercial Laundry API로 여러분에게 필요한 서비스를 개발하십시오. 아래 Development Process를 참조하시기 바랍니다. 각 단계별 필요한 정보를 LG 담당자 혹은 본 개발자 사이트를 통해 요청할 수 있습니다.

Key Features

파트너의 서비스 서버는 Commercial Laundry API를 통해 다음 기능을 구현할 수 있습니다.

	Device Management 디바이스(LG 세탁기/건조기)를 원격으로 설정하고 효율적으로 관리할 수 있습니다.
	Usage Pattern Analysis 세탁 코스별 사용 횟수, 기기별 동작 횟수 등 사용 패턴을 효율적으로 분석할 수 있습니다.
	Check the Available Devices 사용 가능한 디바이스가 얼마나 있는지 원격으로 확인할 수 있습니다.
	Laundry Reservation 디바이스를 원격으로 예약할 수 있습니다.
	Check Progress in Real-time 원격으로 디바이스 동작 진행 상태를 실시간으로 확인할 수 있습니다.
	Notification of Completion 디바이스 동작이 완료되면 파트너 서비스 서버의 callback URL로 알림 메시지가 전달됩니다.

예를 들어, 파트너 여러분은 Commercial Laundry API를 이용하여 빨래방 운영자를 위한 대시보드 웹 혹은 빨래방 고객을 위한 앱을 개발할 수 있습니다.


Store Management Dashboard	Customer App
Examples of Partner Service

Terms and Definitions

Commercial Laundry API에서 공통적으로 사용되는 용어의 정의는 다음과 같습니다.

용어 정의
Terms	Description
파트너	LG 디바이스를 사용하여 셀프 세탁 서비스를 운영하고자 하는 서비스 프로바이더(service provider)입니다.
파트너 서버	파트너가 서비스를 운영하고 있는 서버입니다.
Commercial Laundry API	ThinQ 플랫폼이 셀프 빨래방 서비스를 운영하는 파트너를 위해 제공하는 cloud-to-cloud 인터페이스로, RESTful 형태의 API입니다. 파트너의 서비스 서버는 Commercial Laundry API를 통해 ThinQ 플랫폼과 통신합니다.
상업용 세탁 서비스	Commercial Laundry API를 이용하여 개발된 서비스를 의미합니다.
매니저	셀프 세탁 서비스의 점포를 운영하는 운영자(매장의 주인, 직원 등)를 의미합니다.
고객	셀프 세탁 서비스를 실제로 이용하는 고객을 의미합니다.
기기/ 디바이스	셀프 세탁 서비스 점포에 설치된 LG ThinQ 제품(상업용 세탁기/건조기)입니다.
LG Installer App	LG가 제공하는 앱으로, 점포에 설치된 LG ThinQ 제품(상업용 세탁기/건조기)을 ThinQ 플랫폼에 등록시킬 때 사용하는 앱입니다.
Service ID/ Service Key	파트너가 서비스를 LG에 연동 요청하면 발급되는 값입니다. 파트너 서비스 서버가 LG ThinQ 서버에 연동하기 위해서는 LG에 "서비스 생성"을 요청해야 하며, 요청 처리가 완료되면 service id/key가 발급됩니다. Commercial Laundry API를 사용하려면 반드시 이 값이 필요합니다. API 요청 시, 헤더 파라미터 중 하나인 `x-service-id`, `x-service-key` 에 발급받은 값을 입력합니다.