contact.iotoasis@gmail.com

OPEN API란?

개발자는 oasis에서 제공하는 다양한 Open API를 이용하여 원하는 정보(디바이스, 태그스트립, 이벤트, 공개디바이스)를 제공받을 수 있으며 이를 활용하여 IoT 서비스를 만들 수 있습니다.

OPEN API 이용하기

· OPEN API 사용
- OPEN API 검색

APP이나 Web에서 사용 가능한 Open API를 검색할 수 있습니다.

- OPEN API Test

검색한 API에 Request Parameter 값을 넣어 테스트 해볼 수 있습니다.

1. 요청 변수 - API Test를 위한 Request Parameter를 입력

2. 응답 모델 - API가 응답하는 예시 모델

3. API 테스트 - 클릭하면 API 테스트를 실행

4. 실제 응답 - API의 실제 테스트 값

OPEN API 구조

oasis에서는 다음과 같은 기본 표준체계를 사용하고 있으므로 원활한 개발을 위하여 API규격에 대한 숙지를 하시기 바랍니다.
· HTTP 메소드

· GET

· POST

· PUT

· DELETE

(PUT, DELETE 메소드 미지원 브라우저는 사용이 제한적임)

· URL구조 (RESTful 방식)
https://iotoasis.org/

· version : Open API 버전을 의미하며 IoT OPEN API 에 명시됨 (ex v1, v2)

· Resource Category : API의 분류를 의미하며 복수명사로 사용 (ex devices, streams)

· Resource : Resource Category 하위의 세부 분류

· Path Variable : API 의 필수 변수이며 Resource 의 중요 key값에 대응됨

· Query String : URL뒤에 위치하는 변수이며 변수명과 값을 key=value 형식으로 명시, 요청 변수가 많으면 ‘&’으로 구분

· Key Value value (KV Value) : POST, PUT 메소드 사용시 Request Body에 담겨지는 변수 json 형식을 사용하며 “{key:value}” 형식으로 명시

· 리턴형식
JSON형식을 사용하며 { key : value } 형식으로 리턴하며 각 API별 세부 내용은 다르므로 IoT OPEN API 참조

- 리턴 상태 코드

200 OK - 성공
204 No Content - 서버로 요청은 했으나 아무런 리턴 값이 없음
400 Bad Request - 잘못된 URL요청
401 Unauthorized - 인증 실패
403 Forbidden - 제한된 URL요청
404 Not Found - 제공되지 않는 URL 요청
405 Method Not Allowed - 지원하지 않는 HTTP Method 요청
500, 502, 503, 504 Server errors - 서버 에러

-

 ************ 전송헤더 리스트
["Accept: application\/json","HOST: 10.101.101.193","X-M2M-RI: pm_1506031057180014","X-M2M-Origin: \/\/iot.herit.net\/csebase\/CAE0003"]

************ 응답
HTTP/1.1 200 OK
CONTENT-LENGTH: 108
X-M2M-RSC: 2000
X-M2M-RI: pm_1506031057180014
X-M2M-ORIGIN: //10.10.224.240/herit-in
CONTENT-TYPE: application/json
Connection: close

{
   "uril" : {
      "URIList" : [ "/herit-in/herit-cse/AE1", "/herit-in/herit-cse/AE1/container1" ]
   }
}
                                    

· responseCode : OK(성공), NG(실패)

· message : 실패시 메시지

· data : 요청 결과 데이터

· data.total : 결과 데이터 총 개수

· data.page : 현재 페이지

· data.rowNum : 한페이지 의 row갯수

· data.rows : 결과 데이터 내용

About Us

Meet the open-source IoT platforms that are available to everyone! With the Internet of Things that can help you connect to anything, the era where internet-connected devices can operate autonomously has begun.