API Call Sequence

Commercial Laundry API의 사용 방법을 API 호출 흐름을 통해 설명합니다.

기기 목록 조회하기

기기 목록을 조회하는 방법을 설명합니다.

Related APIs

• GET {{BASE_URL}}/devices

Sequence

1. 기기 목록 조회 API (GET /devices)를 호출합니다.

기기 정보 조회하기

특정 기기의 정보를 조회하는 방법을 설명합니다.

Related APIs

• GET {{BASE_URL}}/devices

• GET {{BASE_URL}}/devices/<device-id>

Sequence

1. 기기 목록 조회 API (GET /devices)를 호출합니다. (이미 기기 목록을 가지고 있다면, 이 단계는 생략합니다.)
2. 응답 메시지의 기기 목록에서 원하는 기기의 device-id를 확인합니다.
3. 해당 기기에 대해, 기기 정보 조회 API (GET /devices/<device-id>)를 호출합니다.

기기 예약 하기

기기를 사용하지 못하도록 기기를 예약하는 방법을 설명합니다. 

Related APIs

• GET  {{BASE_URL}}/devices

• POST {{BASE_URL}}/devices/<device-id>/reserve

Sequence

1. 기기 목록 조회 API (GET /devices)를 호출합니다. (이미 기기 목록을 가지고 있다면, 이 단계는 생략합니다.)
2. 응답 메시지의 기기 목록에서 원하는 기기의 device-id를 확인합니다.
3. 해당 기기에 대해, 기기 예약 API (POST /devices/<device-id>/reserve)를 호출합니다.

예약된 기기 목록 조회하기

예약된 기기 목록을 조회하는 과정을 설명합니다.

Related APIs

• GET {{BASE_URL}}/devices?searchType=reserved

Sequence

1. 기기 목록 조회 API 를 호출합니다. 이때, 쿼리 파라미터인 searchType의 값을 reserved로 입력하여 예약된 기기 목록을 요청합니다. (GET /devices?searchType=reserved)

기기 예약 해제하기

기기 예약을 해제하는 과정을 설명합니다.

Related APIs

• GET    {{BASE_URL}}/devices?searchType=reserved

• DELETE {{BASE_URL}}/devices/<device-id>/reserve

Sequence

1. 기기 목록 조회 API (GET /devices?searchType=reserved)를 호출합니다. 이때, 쿼리 파라미터인 searchType의 값을 reserved로 입력하여 예약된 기기 목록을 요청합니다. (이미 예약된 기기 목록을 가지고 있다면, 이 단계는 생략합니다.)
2. 응답 메시지의 기기 목록에서 원하는 device-id 값을 확인합니다.
3. 해당 기기에 대해, 기기 예약 해제 API (DELETE /devices/<device-id>/reserve)를 호출합니다.

 

기기 사용 준비하기

기기 사용을 준비하는 과정을 설명합니다.

Related APIs

• GET  {{BASE_URL}}/devices/<device-id>

• POST {{BASE_URL}}/devices/<device-id>/ready

Sequence

1. 사용자가 기기의 코스를 선택합니다.
2. 사용자가 결제를 요청합니다. 이 때, 기기 정보 조회 API (GET /devices/<device-id>)를 호출하여, 결제 필요 금액을 조회합니다.
3. 결제를 진행합니다. (LG는 결제 관련 기능은 지원하지 않습니다.)
4. 결제가 완료되면, 기기 사용 준비 API (POST /devices/<device-id>/ready)를 호출합니다.