Heitu 대시보드에 등록된 사용자 정의 장치에 센서 데이터를 입력하기 위한 API 입니다.
데이터 입력 #
요청하기 #
센서데이터 입력은 https 프로토콜로 GET 메소드로 인수를 전달함으로써 수행할 수 있습니다. API의 기본 사항은 다음과 같습니다.
URL | 매서드 |
---|---|
https://heitu.1778tech.com/api | GET |
https://heitu.1778tech.com/api?cmd={cmd}&device_id={device_id}&user_id={user_id}&apikey={apikey}&payload={payload}&datetime={datetime}
인수 #
센서 데이터 입력을 위하여 입력해야 하는 값 입니다.
인수 명 | 형식 | 설명 | 필수 여부 |
---|---|---|---|
cmd | 문자열 | write | O |
device_id | 문자열 | 장치의 ID | O |
user_id | 문자열 | 사용자 ID (예: [email protected]) | O |
apikey | 문자열 | 발급 받은 API key | O |
payload | JSON | 입력할 센서의 데이터 페이로드 | O |
datetime | 날짜 및 시간 YYYY-MM-DD hh:mm:ss | 센서 데이터 입력 시간 (예 : 2024-01-01 09:00:00) | X |
참고 - time을 입력하지 않으면 API 요청을 보낸 시간을 바탕으로 센서 데이터가 입력 및 저장 됩니다.
데이터 페이로드 #
입력할 데이터 페이로드(payload)는 JSON Array로 구성됩니다. 페이로드의 각 요소는 아래와 같은 키-값 쌍으로 이루어져 있습니다.
키 | 형식 | 값 |
---|---|---|
name | 문자열 | 입력할 데이터의 이름. “data”+숫자 접미사로 이루어진다. 숫자 접미사는 양의 정수이며, 사용자 정의 장치의 설정에서 지정한 센서 데이터 가짓 수 이하의 값이어야 한다. 예를들어 3 종류의 센서 데이터 가짓수를 설정하였다면, data1, data2, data3 중 하나의 값을 설정할 수 있다. |
value | 유리수 | 입력할 데이터의 값. |
예시 #
※센서 데이터 가짓수가 3인 경우 [ { "name":"data1", "value":10 }, { "name":"data2", "value":20 }, { "name":"data3", "value":30 } ]
응답 #
응답은 JSON 형식으로 data, result_code 두 개의 항목으로 구성되며 그 예는 다음과 같습니다.
{ "data": [ { "date": "1703788144.972526", "name": "data1", "value": "10" }, { "date": "1703788144.972526", "name": "data2", "value": "20" }, { "date": "1703788144.972526", "name": "data3", "value": "30" } ], "result_code": "200" }
응답 설명 #
항목명 | 값 |
---|---|
data | 입력된 데이터 |
result_code | 응답 코드 |
입력된 데이터 #
항목명 | 값 |
---|---|
date | 입력 요청한 시간 – 유닉스 시간 |
name | 해당 데이터의 번호 – data1 ~ data10 |
value | 해당 데이터의 값 |
응답코드 #
응답코드 | 설명 |
---|---|
200 | 정상적인 응답 |
302 | 입력한 인수의 오류 |
304 | 데이터베이스 오류 |
306 | 접근경로 오류 등 기타 오류 |
309 | 권한 없음 |