導航中心

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.

赛马会资料中心www.009