Key｜裝置管理

API Domain

https://ioeapi.nextdrive.io

Device Management

① Get Device List

Summary

① Get Device List

Path

GET /v1/gateways/{productId}/devices

Description

Through this API, you can get the list of devices associated with the gateway and their connection status by productId.

Request Header

X-ND-TOKEN

API Key created by IoE Suite Developer

content-type

application/json

Request Params

Example Value
JSON
productId: "NDTEST1234567"

Schema
JSON
productId: string(NextDrive defined DSN)


200

Response

Status Code

200

Description

Successful request

Content Type

application/json

Example Value
JSON
{
  "devices": [
    {
      "deviceUuid": "bbfff39c - af1d - 011 a - 2830 - 0006 f29912aa",
      "model": "TaipowerMeter",
      "name": "Joe 's Smart Meter",
      "onlineStatus": "online"
    }
  ]
}

Schema
JSON
{
  "devices": [
    {
      "deviceUuid": string,
      "model": string,
      "name": string,
      "onlineStatus": string
    }
  ]
}
401

Response

Status Code

401

Description

Unauthorized

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  path: string,
  timestamp: string
}

Schema

API key is invalid
403

Response

Status Code

403

Description

Forbidden

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Gateway productId (${productId}) user not subscribe related service
404

Response

Status Code

404

Description

Not found

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Gateway productId (${productId}) not found
500

Response

Status Code

500

Description

System error

Content Type

application/json

Example Value

 
{
  status: integer,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Internal Server Error
② Get Gateway Status

Summary

② Get Gateway Status

Path

GET /v1/gateways/{productId}/status

Description

Through this API, you can get the gateway connection status by productId.

Request Header

X-ND-TOKEN

API Key created by IoE Suite Developer

content-type

application/json

Request Params

Example Value
JSON
productId: "NDTEST1234567"

Schema
JSON
productId: string(NextDrive defined DSN)


200

Response

Status Code

200

Description

Successful request

Content Type

application/json

Example Value
JSON
{
  "name": "Joe's Cube",
  "model": "Cube-PLUS",
  "fwVersion": "Cube-PLUS-4.0.16012",
  "onlineStatus": "online"
}

Schema
JSON
{
  "name": string,
  "model": string,
  "fwVersion": string,
  "onlineStatus": string
}
401

Response

Status Code

401

Description

Unauthorized

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  path: string,
  timestamp: string
}

Schema

API key is invalid
403

Response

Status Code

403

Description

Forbidden

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Gateway productId (${productId}) user not subscribe related service
404

Response

Status Code

404

Description

Not found

Content Type

application/json

Example Value
JSON
{
  status: integer,
  title: string,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Gateway productId (${productId}) not found
500

Response

Status Code

500

Description

System error

Content Type

application/json

Example Value

 
{
  status: integer,
  message: string,
  requestId: string,
  path: string,
  timestamp: string
}

Schema

Internal Server Error