导航中心

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

传感器 Sensors

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

API列表
/v1.0/device/<device_id>/sensors创建传感器在线调试
/v1.0/device/<device_id>/sensor/<sensor_id>编辑传感器在线调试
/v1.0/device/<device_id>/sensors罗列传感器在线调试
/v1.0/device/<device_id>/sensor/<sensor_id>查看传感器在线调试
/v1.0/device/<device_id>/sensor/<sensor_id>删除传感器在线调试

创建传感器

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

URL

http://api.yeelink.net/v1.0/device/<device_id>/sensors

Note: 对该URL的一个HTTP POST请求将为您指定的设备创建一个新的传感器, 其中<device_id>为指定设备的id.

请求参数

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

数据格式

JSON

数据格式说明

  • 数值型传感器
  • gps型传感器
  • 泛型传感器
  • 图像型传感器
  • 参数名 必需 类型 说明
    type true string 传感器类型
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    unit false json name:string 温度,symbol:float 摄氏度
    {
      "type":"value",
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"],
      "unit": {
         "name": "temperature",
         "symbol": "C"
       }
    }
  • 参数名 必需 类型 说明
    type true string 传感器类型
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "type":"gps",
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
      
    }
  • 参数名 必需 类型 说明
    type true string 传感器类型
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "type":"gen",
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
      
    }
  • 参数名 必需 类型 说明
    type true string 传感器类型
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "type":"photo",
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
      
    }

Note: 若不带"type", 默认为数值型传感器.

Method

POST

返回值

新设备的ID

参数名 类型 说明
device_id int 设备id
{
  "sensor_id": 2
}

访问授权

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

请求实例 (运用curl):

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

    Note:datafile.txt中,需要在HTTP Header中增加API Key来授权写入操作, 具体请参照API Key.

编辑传感器

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

URL

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

Note: 对该URL的一个HTTP PUT请求将更新传感器的信息, 其中<device_id>为所要更新的传感器所属设备的id,<sensor_id>为所要更新的传感器的id. 若您的客户端不支持PUT请求, 请使用url方式模拟, 具体参照模拟PUT, DELETE请求.

请求参数

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

数据格式

JSON

数据格式说明

  • 数值型传感器
  • gps型传感器
  • 泛型传感器
  • 图像型传感器
  • 参数名 必需 类型 说明
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    unit false json name:string 温度,symbol:float 摄氏度
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"],
      "unit": {
         "name": "temperature",
         "symbol": "C"
        }
    }
  • 参数名 必需 类型 说明
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }
  • 参数名 必需 类型 说明
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }
  • 参数名 必需 类型 说明
    title true string 传感器标题
    about false string 传感器简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }

Method

PUT

返回值

HTTP Headers only

请求实例 (运用curl):

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

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

罗列传感器

URL

http://api.yeelink.net/v1.0/device/<device_id>/sensors

Note: 对该URL的一个HTTP GET请求将得到所有属于某一设备传感器的列表, 为所要罗列的传感器所属的设备id.

请求参数

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

数据格式

JSON

数据格式说明

参数名 必需 类型 说明
id true int 设备ID
title true string 设备标题
about false string 设备简介
[
  {
    "id": 2,
    "title": "test2",
    "about": "just a test",
    "type":0,
    "last_update": 1380009649,
    "last_data":"317",
    "last_data_gen":null
	},
	{
    "id": 3,
    "title": "test3",
    "about": "just a test",
    "type":6,
    "last_update": 1380009669,
    "last_data":null;,
    "last_data_gen":{"lat":23.8,"lng":54.5,"speed":45}
  }
]

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/sensors

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

查看传感器

URL

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

Note: 对该URL的一个HTTP GET请求将得到所要查看传感器的详细内容, 其中<sensor_id>为所要查看的传感器的id,<device_id>为此传感器所属的设备的id.

请求参数

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

数据格式

JSON

数据格式说明

  • 数值型传感器
  • gps型传感器
  • 泛型传感器
  • 图像型传感器
  • 参数名 必需 类型 说明
    title true string 设备标题
    about false string 设备简介
    tags false array 标签数组
    tags false array 标签数组
    unit_name false string 温度
    unit_symbol false float 摄氏度
    [{
      "title":"test",
      "about":"just a test",
      "tags":["tag1","tag2"],
      "unit_name": "temperature",
      "unit_symbol": "C"
    }]
  • 参数名 必需 类型 说明
    title true string 设备标题
    about false string 设备简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }
  • 参数名 必需 类型 说明
    title true string 设备标题
    about false string 设备简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }
  • 参数名 必需 类型 说明
    title true string 设备标题
    about false string 设备简介
    tags false array 标签数组
    tags false array 标签数组
    {
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"]
    }

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

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

删除传感器

URL

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

Note: 对该URL的一个HTTP DELETE请求将删除指定的传感器, 其中为所要删除的传感器的id, 为该传感器所属的设备的id. 若您的客户端不支持DELETE请求, 请使用url方式模拟, 具体参照模拟PUT, DELETE请求.

Method

DELETE

返回值

HTTP Headers only

访问授权

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

请求实例

  • CURL
  • curl --request DELETE --header "U-ApiKey: YOUR_API_KEY_HERE" http://api.yeelink.net/v1.0/device/12/sensor/3

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