API文档 -湖畔科技物联平台

数据点 Datapoints

一个device表示一组传感器的集合.

API列表
/v1/Device/	创建设备
/v1/Device/{device_id}	编辑设备
v1/Devices/{device_id}	罗列设备
/v1/Device/{device_id}	查看设备
v1/Device/{device_id}	删除设备

创建设备

对该URL的一个HTTP POST请求将为您创建一个新的设备.

URL

/v1/Device/

数据格式

JSON

数据格式说明

参数名	必需	类型	说明
title	true	string	设备标题
tags	false	string	设备标签
about	false	string	设备描述
locate	false	string	设备地址
device_lng	false	string	设备经度
device_lat	false	string	设备纬度

        {
        "title":"test",
        "about":"test api",
        "tags":"temperature,lab"
        }

Method

POST

返回值

新设备的ID

参数名	类型	说明
device_id	int	设备ID

{
    "device_id": 2
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

编辑设备

根据设备ID编辑已经接入的设备

URL

/v1/Device/{device_id}

参数名	必需	类型	说明
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

参数名	必需	类型	说明
title	true	string	设备标题
tags	false	string	设备标签
about	false	string	设备描述
locate	false	string	设备地址
device_lng	false	string	设备经度
device_lat	false	string	设备纬度

{
        "title":"test",
        "about":"test api",
        "tags":"temperature,lab"
}

Method

PUT

返回值

修改设备的ID

参数名	类型	说明
device_id	int	设备ID

{
    "device_id": 2
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

罗列设备

对该URL的一个HTTP GET请求将得到所有设备信息的列表.

URL

/v1/Devices/{device_id}

参数名	必需	类型	说明
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

参数名	必需	类型	说明
id	true	string	设备ID
title	true	string	设备名称
about	false	string	设备描述

[
        {
        "id": "2",
        "title": "test2",
        "about": "just a test"
        },
        {
        "id": "3",
        "title": "test3",
        "about": "just a test"
        }
]

Method

GET

返回值

用户所有的设备

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

查看设备

对该URL的一个HTTP GET请求将得到所要查看设备的详细内容,其中{device_id}为所要查看的设备的id.

URL

/v1/Device/{device_id}

请求参数

参数名	必需	类型	说明
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

参数名	必需	类型	说明
title	true	string	设备名称
about	false	string	设备描述
tags	false	string	设备标签
locate	false	string	设备位置
device_lng	false	string	设备经度
device_lat	false	string	设备纬度

{
        "title": "test3",
        "about": "just a test",
        "tags": "lab",
        "local": "Qingdao",
        "latitude": 0.444,
        "longitude": 0.555
}

Method

GET

返回值

请求的设备信息

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

传感器 Sensors

传感器完成采集数据的功能, 一个设备支持多个传感器.

API列表
/v1/sensors/{device_id}	创建传感器
/v1/sensors/{sensors_id}/Device/{device_id}	编辑传感器
	罗列传感器
/v1/sensors/{sensors_id}/Device/{device_id}	查看传感器
/v1/sensors/{sensors_id}/Device/{device_id}	删除传感器

创建设备

对该URL的一个HTTP POST请求将为您创建一个新的传感器.

URL

/v1/sensors/{device_id}

请求参数

参数名	必需	类型	说明
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

数值型传感器

参数名	必需	类型	说明
type	true	string	传感器类型
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签
unit	false	string	单位
symbol	false	string	符号

{
        "type":"value",
        "title":"test",
        "about":"test api",
        "tags":"test",
        "unit":"temperature",
        "symbol": "C"
}

gps型传感器

参数名	必需	类型	说明
type	true	string	传感器类型
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{
        "type":"gps",
        "title":"test",
        "about":"test api",
        "tags":"test"
}

泛型传感器

参数名	必需	类型	说明
type	true	string	传感器类型
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{ "type":"gen", "title":"test", "about":"test api", "tags":"test" }

Method

POST

返回值

新传感器设备的ID

参数名	类型	说明
sensor_id	int	设备ID

{
        "sensor_id": 2
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

编辑传感器

根据设备ID编辑已经接入的传感器.

URL

/v1/sensors/{sensors_id}/Device/{device_id}

请求参数

参数名	必需	类型	说明
sensors_id	true	string	传感器ID
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

数值型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签
unit	false	string	单位
symbol	false	string	符号

{
        "title":"test",
        "about":"test api",
        "tags":"test",
        "unit":"temperature",
        "symbol": "C"
}

gps型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{
        "title":"test",
        "about":"test api",
        "tags":"test"
}

泛型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{

        "title":"test",
        "about":"test api",
        "tags":"test"
}

Method

PUT

返回值

修改传感器设备的ID

参数名	类型	说明
sensor_id	int	设备ID

{
        "sensor_id": 2
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

查看传感器

根据设备ID和传感器ID查询传感器信息.

URL

/v1/sensors/{sensors_id}/Device/{device_id}

请求参数

参数名	必需	类型	说明
sensors_id	true	string	传感器ID
device_id	true	string	设备ID

数据格式

JSON

数据格式说明

数值型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签
unit	false	string	单位
symbol	false	string	符号

{
        "title":"test",
        "about":"test api",
        "tags":"test",
        "unit":"temperature",
        "symbol": "C"
}

gps型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{
        "title":"test",
        "about":"test api",
        "tags":"test"
}

泛型传感器

参数名	必需	类型	说明
title	true	string	传感器名称
about	false	string	传感器简介
tags	false	string	传感器标签

{

        "title":"test",
        "about":"test api",
        "tags":"test"
}

Method

GET

返回值

请求的传感器信息

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

删除传感器

根据设备ID和传感器ID查询传感器信息.

URL

/v1/sensors/{sensors_id}/Device/{device_id}

请求参数

参数名	必需	类型	说明
sensors_id	true	string	传感器ID
device_id	true	string	设备ID

Method

DELETE

返回值

成功返回:success

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

数据点 Datapoints

一个datapoint是由key和value组成的键值对.

API列表
/v1/datapoints/device/{device_id}/sensor/{sensors_id}	创建数据点
	编辑数据点
v1/datapoints/device/{device_id}/sensor/{sensors_id}	查看数据点
v1/datapoints/device/{device_id}/sensors/{sensors_id}	删除数据点

创建数据点

对该URL的一个HTTP POST请求会为指定的传感器创建一个新的数据点, 使用此API来为传感器存储历史数据.

URL

/v1/datapoints/device/{device_id}/sensor/{sensors_id}

请求参数

参数名	必需	类型	说明
device_id	true	string	设备ID
sensors_id	true	string	传感器ID

数据格式

JSON

数据格式说明

一个datapoint是由key和value组成的键值对.

参数名	必需	类型	说明
key	true	string	键
value	true	string	值

数值型传感器

key为timestamp, value为数值

gps型传感器

key为timestamp, value为JSON格式, 由经度、纬度、速度等GPS信息组成.

泛型传感器

key为用户自定义字符串; value为JSON格式,由用户自定义具体内容

Note: key为唯一索引; timestamp为ISO 8601标准时间格式, 例如：2017-10-2 14:57:17.

上传数据例子(JSON)

数值型传感器

{
  "timestamp":"2017-10-2 14:57:17",
  "value":294.34
}

GPS型传感器

{
  "timestamp":"2017-10-2 14:57:17",
  "value":{"lat":35.4567,"lng":46.1234,"speed":98.2}
}

泛型传感器

             {
  "key":"e10adc3949ba59abbe56e037f20f884e",
  "value":{...}
}

Method

POST

返回值

成功返回:success

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

查看数据点

对该URL的请求返回指定key的datapoint

URL

/v1/datapoints/device/{device_id}/sensor/{sensors_id}

请求参数

参数名	必需	类型	说明
sensors_id	true	string	传感器ID
device_id	true	string	设备ID

Method

GET

返回值

请求的传感器信息

返回值数据格式

JSON

数值型传感器

{
	"timestamp":"2017-10-2 14:57:17",
	"value": 39.2
}

gps型传感器

{
	"timestamp":"2017-10-2 14:57:17",
	"value": {"lat":35.4321,"lng":46.3451,"speed":98.2}
}

泛型传感器

{
	"key":"e10adc3949ba59abbe56e037f20f884e",
	"value": {...}
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}

删除数据点

其中{sensor_id}为所要删除的数据所属传感器的id,{device_id}为所要删除的数据所属设备的id

URL

v1/datapoints/device/{device_id}/sensors/{sensors_id}

请求参数

参数名	必需	类型	说明
sensors_id	true	string	传感器ID
device_id	true	string	设备ID

Method

DELETE

返回值

成功返回success

数值型传感器

{
	"timestamp":"2017-10-2 14:57:17",
	"value": 39.2
}

gps型传感器

{
	"timestamp":"2017-10-2 14:57:17",
	"value": {"lat":35.4321,"lng":46.3451,"speed":98.2}
}

泛型传感器

{
	"key":"e10adc3949ba59abbe56e037f20f884e",
	"value": {...}
}

访问授权

需要在HTTP Header中增加API Key来授权写入操作

u-apikey:{key}