API Call Sequence
DR API를 사용하여 DR 서비스를 개발하는 방법을 API 호출 흐름을 통해 설명합니다.
User Registration
DR 서비스 사용자를 등록하는 과정을 설명합니다.
APIs to be used
-
GET {{EMPBaseUrl}}/authorize
-
POST {{EMPBaseUrl}}/token
-
GET {{EMPBaseUrl}}/profile
Sequence
사용자 등록은 표준 OAuth 프로토콜을 사용합니다. 여러분은 기본 EMP API를 활용하여 LG EMP 서비스에서 액세스 토큰(access_token)을 얻을 수 있습니다. 사용자를 등록하는 기본 단계는 다음과 같습니다.
1. LG EMP API (POST {{EMPBaseUrl}}/token)를 호출하여 액세스 토큰(accessToken)을 받습니다.
2. LG EMP에서 사용자 ID (userID)와 사용자 번호(userNo)를 얻기 위해, GET Profile API (GET {{EMPBaseUrl}}/profile)를 호출합니다.
3. DR 서비스에 등록된 리소스가 없는 경우, Create Resource API (POST {{baseUrl}}/resources)를 호출하여 리소스를 등록합니다.
4. Create User API (POST {{baseUrl}}/users)를 호출하여 DR 서비스에 사용자를 등록합니다.
5. 사용자 등록이 정상적으로 완료되면, 반환 값으로 등록된 사용자 ID를 받습니다.
User Deletion
등록된 사용자를 삭제하는 과정을 설명합니다.
APIs to be used
Sequence
1. 사용자 삭제를 위해 Delete User API (DELETE {{baseUrl}}/users/{user-id})를 호출합니다.
2. 해당 user-id가 DR 서비스에 등록된 사용자인지 확인 후, 사용자와 사용자의 디바이스 정보를 삭제합니다.
- 만약 해당
user-id가 DR 서비스에 등록되어 있지 않은 경우, "User not Found" 에러가 발생합니다.
DR Request Registration
DR Request를 등록하는 과정을 설명합니다.
APIs to be used
Sequence
1. LG DR 서비스 서버에 DR Request를 등록하기 위해 Create DR Request API (POST {{baseUrl}}/requests)를 호출합니다.
2. DR Request가 정상적으로 등록되면, 반환 값으로 DR Request ID (requestID)를 받습니다.
DR Request Deletion
등록된 DR Request를 삭제하는 과정을 설명합니다.
APIs to be used
Sequence
1. LG DR 서비스 서버에서 DR Request를 삭제하기 위해 Delete DR Request API (DELETE {{baseUrl}}/requests/{dr-id})를 호출합니다.
- 만약
dr-id에 해당하는 DR Request가 없다면, "DR not Found" 에러가 발생합니다. - 만약
dr-id에 해당하는 DR Request가 pending 상태가 아니라면, "Not Allowed" 에러가 발생합니다.
2. DR Request가 정상적으로 삭제되면, 반환 값으로 해당 DR Request ID를 받습니다.
Data Collecting
LG DR 서비스 서버에 저장된 디바이스 상태 정보 데이터를 ZIP 파일로 생성하고 다운로드하는 과정을 설명합니다.
APIs to be used
Sequence
1. Create Data ZIP File API (POST {{baseUrl}}/data-zip/files)를 호출하여 지정한 시간대의 데이터(ZIP 파일)를 요청합니다.
2. ZIP 파일이 생성되면, 반환 값으로 생성된 ZIP 파일의 이름을 전받습니다.
3. 파일을 다운로드하려면, Download a Data ZIP File API (GET {{baseUrl}}/data-zip/files/{fileName})를 호출합니다.