导航中心

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

设备 Devices

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

API列表
/v1.0/devices创建设备在线调试
/v1.0/device/<device_id>编辑设备在线调试
/v1.0/devices罗列设备在线调试
/v1.0/device/<device_id>查看设备在线调试
/v1.0/device/<device_id>删除设备在线调试

创建设备

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

URL

http://api.yeelink.net/v1.0/devices

请求参数

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

数据格式

JSON

数据格式说明

参数名 必需 类型 说明
title true string 设备标题
about false string 设备简介
tags false array 标签数组
tags false array 标签数组
location false json local: string 地点名称,latitude: float 经度, longitude: float 纬度
{
     "title":"test",
     "about":"test api",
     "tags":["temperature","lab"],
     "location":{
    "local":"Qingdao",
    "latitude":0.444,
    "longitude":0.555
   }
}

Method

POST

返回值

新设备的ID

参数名 类型 说明
device_id int 设备id
{
	"device_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/devices

    Note:只需将要修改的设备信息放到datafile.txt中,需要在HTTP Header中增加API Key来授权写入操作, 具体请参照API Key.

编辑设备

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

URL

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

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

请求参数

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

数据格式

JSON

数据格式说明

参数名 必需 类型 说明
title true string 设备标题
about false string 设备简介
tags false array 标签数组
tags false array 标签数组
location false json local: string 地点名称,latitude: float 经度, longitude: float 纬度
{
    "title":"test",
    "about":"just a test",
    "tags":["lab","temperature"],
    "location":{
    "local":"Qingdao",
    "latitude":0.444,
    "longitude":0.555
	}
}

Method

PUT

返回值

HTTP Headers only

访问授权

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

请求实例 (运用curl):

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

    Note:只需将要修改的设备信息放到datafile.txt中,需要在HTTP Header中增加API Key来授权写入操作, 具体请参照API Key.

罗列设备

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

URL

http://api.yeelink.net/v1.0/devices

请求参数

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

数据格式

JSON

数据格式说明

参数名 必需 类型 说明
id true int 设备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来授权GET操作, 具体请参照API Key.

请求实例 (运用curl):

  • CURL
  • curl --request GET --header "U-ApiKey: YOUR_API_KEY_HERE" http://api.yeelink.net/v1.0/devices

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

查看设备

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

URL

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

请求参数

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

数据格式说明

参数名 必需 类型 说明
title true string 设备标题
about false string 设备简介
tags false array 标签数组
tags false array 标签数组
location false json local: string 地点名称,latitude: float 经度, longitude: float 纬度
{
  "title": "test3",
  "about": "just a test",
  "tags": "lab",
  "local": "Qingdao",
  "latitude": 0.444,
  "longitude": 0.555
}

Method

GET

返回值

请求的设备信息

访问授权

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

请求实例 (运用curl):

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

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

删除设备

对该URL的一个HTTP DELETE请求将将删除指定的设备,其中<device_id>为所要删除的设备的id.

URL

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

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

请求参数

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

数据格式

JSON

Method

DELETE

返回值

HTTP Headers only

访问授权

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

请求实例 (运用curl):

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

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