導航中心

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

//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" //api.yeelink.net/v1.0/device/12/sensors

    Note:datafile.txt中,需要在HTTP Header中增加API Key來授權寫入操作, 具體請參照API Key.

編輯傳感器

根據設備ID編輯已經接入的傳感器.

URL

//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" //api.yeelink.net/v1.0/device/12/sensor/3

    Note:需要在HTTP Header中增加API Key來授權寫入操作, 具體請參照API Key.

羅列傳感器

URL

//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" //api.yeelink.net/v1.0/device/12/sensors

    Note:需要在HTTP Header中增加API Key來授權GET操作, 具體請參照API Key.

查看傳感器

URL

//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" //api.yeelink.net/v1.0/device/12/sensor/3

    Note:需要在HTTP Header中增加API Key來授權GET操作, 具體請參照API Key.

刪除傳感器

URL

//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" //api.yeelink.net/v1.0/device/12/sensor/3

    Note:需要在HTTP Header中增加API Key來授權DELETE操作, 具體請參照API Key.