NUBISON Home 사용자 가이드 REST APIs 🇺🇸 English

HTTP

Nubison IoT HTTP 표준 규격입니다.

PreviousTCP/IP

Last updated 3 months ago

Was this helpful?

HTTP

Nubison IoT HTTP 표준 규격입니다.

Nubison IoT 플랫폼에 HTTP를 통해 데이터를 전송하는 디바이스를 연결하기 위한 가이드입니다.

아래 과정을 진행하기 전에, 에 적힌 과정들이 반드시 선행되어야 합니다.

서버 연결

Nubison IoT 플랫폼에 HTTP로 연결하기 위한 정보입니다.

서버 URL: 연동 진행시 안내

디바이스 로그인

Nubison IoT 플랫폼에 디바이스를 로그인합니다.

다른 요청을 진행하기 전에 로그인을 반드시 진행해야 합니다.

로그인 요청 응답으로 돌아오는 액세스 토큰을 이용하여 다른 요청들을 보낼 수 있습니다.

또한 Nubison IoT 플랫폼 웹에서 타임라인에 “클라우드 접속”이 기록됩니다.

POST /devices/login

[Request]

Content-Type: application/x-www-form-urlencoded

<Header>

key

필수 여부

설명

Authorization

Basic <${클라이언트 ID}:${클라이언트 Secret}을 base64 인코딩한 스트링>

ex.

클라이언트 ID = AbCdE123, 클라이언트 Secret = xyzabc123 이라고 하면,

Basic AbCdE123:xyzabc123

여기에서 AbCdE123:xyzabc123를 Base64 인코딩

(Basic QmFzaWMgQWJDZEUxMjM6eHl6YWJjMTIz)을 보내주셔야 합니다.

<Body>

key

required

비고

deviceKey

디바이스 키

[Response] Content-Type: application/json

status

message

body

200

{

"AccessToken" : "...."

}

400

Bad Request

{

"code" :"ERROR401",

"message": "authorization header does not exist."

}

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR403",

"message": "client is not valid."

}

405

Not Found

// 서비스가 존재하지 않는 경우

415

Invalid content-type

// content-type must be application/json

디바이스 로그아웃

NUBISON IoT 플랫폼에서 디바이스가 로그아웃합니다.

사용했던 토큰이 말소되며, Nubison IoT 플랫폼 웹에서 타임라인에 클라우드 접속해제가 기록됩니다.

POST /devices/logout

[Request]

Content-Type: application/json

<Body>

key

필수 여부

설명

accessToken

NUBISON IoT 플랫폼 로그인 시 서버로부터 받은 접근 토큰

deviceKey

디바이스 키

예시

{
  "accessToken": "FDFC4115B4275502fc6a6111",
  "deviceKey": "IQY9TFMH_HTTPABC"
}

[Response] Content-Type: application/json

status

message

body

200

// 서버에서 로그인 시 발급한 access token을 삭제합니다.

400

Bad Request

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR404",

"message": "accessToken is missing."

}

401

Unauthorized

// accessToken is not valid.

405

Not Found

service is not found. or device is not registered.

415

Invalid content-type

// content-type must be application/json

데이터 전송

Nubison IoT 플랫폼에 디바이스 데이터를 전송합니다.

POST /devices/data

[Request] Content-Type: application/json

<Body>

key

필수 여부

비고

accessToken

로그인 시 서버로부터 받은 접근 토큰

deviceKey

디바이스 키

data

디바이스 데이터

[Response] Content-Type: application/json

status

message

body

201

Created

400

Bad Request

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR404",

"message": "accessToken is missing."

}

{

"code" :"ERROR406",

"message": "data is missing."

}

401

Unauthorized

// accessToken is not valid.

415

Invalid content-type

// content-type must be application/json

자동 드라이버 이용 시 기본 페이로드 규격

Nubison IoT 플랫폼에서 자동 생성된 드라이버를 이용하는 경우 Body의 data 값을 다음과 같이 보내주시면 디바이스가 보낸 데이터를 Nubison IoT 플랫폼에 저장할 수 있습니다.

{
  ...
  "data": {
    "유닛번호": 유닛 값
  }
}

자동드라이버를 이용하시는 경우 다음과 같이 데이터를 구성하시면 됩니다.

"|" 로 구분하여 일련의 문자열로 전송합니다. (자동 생성된 드라이버를 이용하는 경우, 디바이스가 보낸 데이터를 Nubison IoT 플랫폼 서버에서 "|" 로 데이터를 자른 후 유닛 번호 순서대로 데이터를 넣어 저장하게 됩니다.)
숫자, 위치 데이터는 숫자 포맷으로,
문자 데이터는 문자 포맷으로,
숫자 배열 데이터는 ","로 연접한 숫자
문자 배열 데이터는 ","로 연접한 문자
이미지는 base64로 인코딩한 스트링

0번: 온도 (숫자)
1번: 습도 (숫자)
2번: 모드 (문자)
3번: 위도 (위치)
4번: 경도 (위치)
5번: 온도 데이터 배열 (숫자 배열)
6번: 모드 데이터 배열 (문자 배열)
7번: 촬영 이미지 (이미지)

데이터를 다음과 같이 보낸다면

0번 유닛 "온도" 데이터 값: 32
1번 유닛 "습도" 데이터 값: 46
2번 유닛 "모드" 데이터 값: "default"
3번 유닛 "위도" 데이터 값: 38.23
4번 유닛 "경도" 데이터 값: 128.34
5번 유닛 "온도 데이터 배열" 데이터 값: [27,28,24,23,25]
6번 유닛 "모드 데이터 배열" 데이터 값: ["default", "sleep", "mood"]
7번 유닛 "이미지" 데이터 값: /9j/4AAQSkZJRgABAQAAAQABAAD/2w...

페이로드를 다음과 같이 구성해주시면 됩니다.

{
    "deviceKey": "AZ29TVMH_HTTPSAMPLE123", // 데이터를 보낼 디바이스의 디바이스 키
    "accessToken": "CDAC4215B4271202fc6a6111", // POST /devices/login을 통해 받은 액세스 토큰
    "data": {
        "0": 32,
        "1": 84,
        "2": "default",
        "3": 38.23,
        "4": 128.34,
        "5": [27,28,24,23,25],
        "6": ["default", "sleep", "mood"],
        "7": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w..."
    }
}

PreviousTCP/IP

Last updated 3 months ago

Was this helpful?

Nubison IoT 플랫폼에 HTTP를 통해 데이터를 전송하는 디바이스를 연결하기 위한 가이드입니다.

아래 과정을 진행하기 전에, 에 적힌 과정들이 반드시 선행되어야 합니다.

서버 연결

Nubison IoT 플랫폼에 HTTP로 연결하기 위한 정보입니다.

서버 URL: 연동 진행시 안내

디바이스 로그인

Nubison IoT 플랫폼에 디바이스를 로그인합니다.

다른 요청을 진행하기 전에 로그인을 반드시 진행해야 합니다.

로그인 요청 응답으로 돌아오는 액세스 토큰을 이용하여 다른 요청들을 보낼 수 있습니다.

또한 Nubison IoT 플랫폼 웹에서 타임라인에 “클라우드 접속”이 기록됩니다.

POST /devices/login

[Request]

Content-Type: application/x-www-form-urlencoded

<Header>

key

필수 여부

설명

Authorization

Basic <${클라이언트 ID}:${클라이언트 Secret}을 base64 인코딩한 스트링>

ex.

클라이언트 ID = AbCdE123, 클라이언트 Secret = xyzabc123 이라고 하면,

Basic AbCdE123:xyzabc123

여기에서 AbCdE123:xyzabc123를 Base64 인코딩

(Basic QmFzaWMgQWJDZEUxMjM6eHl6YWJjMTIz)을 보내주셔야 합니다.

<Body>

key

required

비고

deviceKey

디바이스 키

[Response] Content-Type: application/json

status

message

body

200

{

"AccessToken" : "...."

}

400

Bad Request

{

"code" :"ERROR401",

"message": "authorization header does not exist."

}

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR403",

"message": "client is not valid."

}

405

Not Found

// 서비스가 존재하지 않는 경우

415

Invalid content-type

// content-type must be application/json

디바이스 로그아웃

NUBISON IoT 플랫폼에서 디바이스가 로그아웃합니다.

사용했던 토큰이 말소되며, Nubison IoT 플랫폼 웹에서 타임라인에 클라우드 접속해제가 기록됩니다.

POST /devices/logout

[Request]

Content-Type: application/json

<Body>

key

필수 여부

설명

accessToken

NUBISON IoT 플랫폼 로그인 시 서버로부터 받은 접근 토큰

deviceKey

디바이스 키

예시

{
  "accessToken": "FDFC4115B4275502fc6a6111",
  "deviceKey": "IQY9TFMH_HTTPABC"
}

[Response] Content-Type: application/json

status

message

body

200

// 서버에서 로그인 시 발급한 access token을 삭제합니다.

400

Bad Request

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR404",

"message": "accessToken is missing."

}

401

Unauthorized

// accessToken is not valid.

405

Not Found

service is not found. or device is not registered.

415

Invalid content-type

// content-type must be application/json

데이터 전송

Nubison IoT 플랫폼에 디바이스 데이터를 전송합니다.

POST /devices/data

[Request] Content-Type: application/json

<Body>

key

필수 여부

비고

accessToken

로그인 시 서버로부터 받은 접근 토큰

deviceKey

디바이스 키

data

디바이스 데이터

[Response] Content-Type: application/json

status

message

body

201

Created

400

Bad Request

{

"code" :"ERROR402",

"message": "deviceKey is missing."

}

{

"code" :"ERROR404",

"message": "accessToken is missing."

}

{

"code" :"ERROR406",

"message": "data is missing."

}

401

Unauthorized

// accessToken is not valid.

415

Invalid content-type

// content-type must be application/json

자동 드라이버 이용 시 기본 페이로드 규격

{
  ...
  "data": {
    "유닛번호": 유닛 값
  }
}

자동드라이버를 이용하시는 경우 다음과 같이 데이터를 구성하시면 됩니다.

"|" 로 구분하여 일련의 문자열로 전송합니다. (자동 생성된 드라이버를 이용하는 경우, 디바이스가 보낸 데이터를 Nubison IoT 플랫폼 서버에서 "|" 로 데이터를 자른 후 유닛 번호 순서대로 데이터를 넣어 저장하게 됩니다.)
숫자, 위치 데이터는 숫자 포맷으로,
문자 데이터는 문자 포맷으로,
숫자 배열 데이터는 ","로 연접한 숫자
문자 배열 데이터는 ","로 연접한 문자
이미지는 base64로 인코딩한 스트링

0번: 온도 (숫자)
1번: 습도 (숫자)
2번: 모드 (문자)
3번: 위도 (위치)
4번: 경도 (위치)
5번: 온도 데이터 배열 (숫자 배열)
6번: 모드 데이터 배열 (문자 배열)
7번: 촬영 이미지 (이미지)

데이터를 다음과 같이 보낸다면

0번 유닛 "온도" 데이터 값: 32
1번 유닛 "습도" 데이터 값: 46
2번 유닛 "모드" 데이터 값: "default"
3번 유닛 "위도" 데이터 값: 38.23
4번 유닛 "경도" 데이터 값: 128.34
5번 유닛 "온도 데이터 배열" 데이터 값: [27,28,24,23,25]
6번 유닛 "모드 데이터 배열" 데이터 값: ["default", "sleep", "mood"]
7번 유닛 "이미지" 데이터 값: /9j/4AAQSkZJRgABAQAAAQABAAD/2w...

페이로드를 다음과 같이 구성해주시면 됩니다.

{
    "deviceKey": "AZ29TVMH_HTTPSAMPLE123", // 데이터를 보낼 디바이스의 디바이스 키
    "accessToken": "CDAC4215B4271202fc6a6111", // POST /devices/login을 통해 받은 액세스 토큰
    "data": {
        "0": 32,
        "1": 84,
        "2": "default",
        "3": 38.23,
        "4": 128.34,
        "5": [27,28,24,23,25],
        "6": ["default", "sleep", "mood"],
        "7": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w..."
    }
}