导航中心

API文档 (版本1.0,版本 v1.1 测试中)

图像数据

图像信息是由key和value组成的键值对, 图像内容则是二进制图像文件.

API列表
/v1.0/device/<device_id>/sensor/<sensor_id>/photos上传图像在线调试
/v1.0/device/<device_id>/sensor/<sensor_id>/photo/info/<key>获取图像(信息)在线调试
/v1.0/device/<device_id>/sensor/<sensor_id>/photo/content/<key>获取图像(内容)在线调试

上传图像

对该URL的一个HTTP POST请求会为指定的图像传感器上传一幅新的图像, 使用此API来为图像传感器存储图像数据, 目前只支持上传jpg, png, gif类型的图像.

URL

http://api.yeelink.net/v1.0/device/<device_id>/sensor/<sensor_id>/photos

请求参数

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

数据格式

binary

注意:此处格式与数值型传感器等不同,不再使用JSON格式,而是直接上传图片的原始内容

Method

POST

返回值

HTTP Headers only

访问授权

需要在HTTP Header中增加API Key来授权写入操作, 具体请参照API Key.支持一次传送一幅图像数据.

请求实例

  • CURL
  • curl --request POST --data-binary @datafile.jpg --header "U-ApiKey: YOUR_API_KEY_HERE" 
       http://api.yeelink.net/v1.0/device/12/sensor/3/photos

    Note:需要在HTTP Header中增加API Key来授权写入操作, 具体请参照API Key. 支持一次传送一幅图像数据.

    Note:目前限定相邻图像数据上传间隔须大于等于10s, 过于频繁的请求会收到406 Response.

获取图像(信息)

对该URL的请求返回指定key的图像信息, 若未指定key, 则返回该sensor的最新图像信息.

URL

http://api.yeelink.net/v1.0/device/<device_id>/sensor/<sensor_id>/photo/info/<key>

请求参数

参数名 必需 类型 说明
device_id true string 设备ID
sensor_id true string 传感器ID
key false string 图片Key

Method

GET

返回值

图像信息

数据格式

JSON

返回数据格式说明

Note:指定Key

参数名 必需 类型 说明
value true json size, width, height, type
{
	"value":{"size": 45, "width": 240, "height": 320, "type": "jpg"
	}
}

其中size单位为kb.

Note:未指定Key

参数名 必需 类型 说明
timestamp true string key
value true json size, width, height, type
{
  "timestamp":"2012-03-15T16:13:14",
  "value":{"size": 45, "width": 240, "height": 320, "type": "jpg"}
}

请求授权

需要在HTTP Header中增加API Key来授权GET操作, 具体请参照API Key.

请求实例

  • CURL
  • Note:指定Key

    curl --request GET --header "U-ApiKey: YOUR_API_KEY_HERE"
      http://api.yeelink.net/v1.0/device/12/sensor/3/photo/info/2012-03-15T16:13:14

    Note:<key>为所要获取图像的时间戳(ISO 8601格式).

    Note:未指定Key

    curl --request GET --header "U-ApiKey: YOUR_API_KEY_HERE" 
    	http://api.yeelink.net/v1.0/device/12/sensor/3/photo/info

获取图像(内容)

对该URL的请求返回指定key的图像内容, 若未指定key, 则返回该sensor的最新图像内容.

URL

http://api.yeelink.net/v1.0/device/<device_id>/sensor/<sensor_id>/photo/content/<key>

请求参数

参数名 必需 类型 说明
device_id true string 设备ID
sensor_id true string 传感器ID
key false string 图片Key

数据格式

binary

格式说明

参数名 必需 类型 说明
PhotoBinaryData true binary 图像内容
<PhotoBinaryData>

Method

GET

返回值

图像内容

访问授权

需要在HTTP Header中增加API Key来授权GET操作, 具体请参照API Key.

请求实例 (运用curl):

  • CURL
  • curl --request GET --header "U-ApiKey: YOUR_API_KEY_HERE"
      http://api.yeelink.net/v1.0/device/12/sensor/3/photo/content/2012-03-15T16:13:14