導航中心

API文檔 (版本1.0,版本 v1.1 測試中)

數據點 Datapoints

一個datapoint是由key和value組成的鍵值對.

API列表
/v1.0/device/<device_id>/sensor/<sensor_id>/datapoints創建數據點在線調試
/v1.0/device/<device_id>/sensor/<sensor_id>/datapoint/<key>編輯數據點在線調試
/v1.0/device/<device_id>/sensor/<sensor_id>/datapoint/<key>查看數據點在線調試
/v1.0/device/<device_id>/sensor/<sensor_id>/datapoint/<key>刪除數據點在線調試

創建數據點

對該URL的一個HTTP POST請求會為指定的傳感器創建一個新的數據點, 使用此API來為傳感器存儲歷史數據.

URL

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

Note: 目前限定相鄰數據上傳間隔須大于等于10s, 過于頻繁的請求會收到406 Response.

請求參數

參數名必需類型說明
device_idtrueint設備ID
sensor_idtrueint傳感器ID

數據格式

JSON

數據格式說明

一個datapoint是由key和value組成的鍵值對.

參數名必需類型說明
keytruetimestamp
valuetruebinary
  • 數值型傳感器
  • GPS型傳感器
  • 泛型傳感器
  • 圖像傳感器
  • 微博抓取器
  • key為timestamp, value為數值

  • key為timestamp, value為JSON格式, 由經度、緯度、速度等GPS信息組成; 同時可以指定是否修正地圖上顯示的偏移.

  • key為用戶自定義字符串, 大小限定為128個字符; value為JSON格式,由用戶自定義具體內容, 大小限定為1024個字符.

  • key為timestamp, value為圖像二進制信息;

  • 不支持

Note: key為唯一索引; timestamp為ISO 8601標準時間格式(默認時區為中國標準時間CST), 例如:2012-03-15T16:13:14.

單個上傳數據例子(JSON)

  • 數值型傳感器
  • GPS型傳感器
  • 泛型傳感器
  • {
      "timestamp":"2012-03-15T16:13:14",
      "value":294.34
    }
    
  • {
      "timestamp":"2012-03-15T16:13:14",
      "value":{"lat":35.4567,"lng":46.1234,"speed":98.2}
    }
    {
      "timestamp":"2012-03-15T16:13:14",
      "value":{"lat":35.4567,"lng":46.1234,"speed":98.2,"offset":"yes"}
    }
    
  • {
      "key":"e10adc3949ba59abbe56e037f20f884e",
      "value":{...}
    }

批量上傳數據例子(JSON)

  • 數值型傳感器
  • GPS型傳感器
  • 泛型傳感器
  • [
      {"timestamp": "2012-06-15T14:00:00", "value":315.01},
      {"timestamp": "2012-06-15T14:00:10", "value":316.23},
      {"timestamp": "2012-06-15T14:00:20", "value":317.26},
      {"timestamp": "2012-06-15T14:00:30", "value":318},
      {"timestamp": "2012-06-15T14:00:40", "value":317}
    ]
    
  • 暫不支持
  • 暫不支持

Method

POST

返回值

HTTP Headers only

訪問授權

需要在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/sensor/3/datapoints

    Note:需要在HTTP Header中增加API Key來授權寫入操作, 具體請參照API Key. 支持一次傳送一個數據或者批量上傳.

編輯數據點

根據設備ID編輯已經接入的數據點.

URL

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

Note: 對該URL的一個HTTP PUT請求將更新指定數據,其中<device_id>為所要更新的數據所屬設備的id,<sensor_id>為所要更新的數據所屬的傳感器的id.若您的客戶端不支持PUT請求, 請使用url方式模擬, 具體參照模擬PUT, DELETE請求.

請求參數

參數名 必需 類型 說明
device_idtruestring設備ID
sensor_idtruestring傳感器ID
keytruestring為所要更新數據的時間戳(ISO 8601格式)

Method

PUT

返回值

HTTP Headers only

數據格式

JSON

數據格式說明

  • 數值型傳感器
  • GPS型傳感器
  • 泛型傳感器
  • 參數名 必需 類型 說明
    valuetruefloat
    {
      "value": 39.4
    }
  • 參數名 必需 類型 說明
    valuetruejson{"lat":35.4321,"lng":46.3451,"speed":98.2}
    {
    	"value": {"lat":35.4321,"lng":46.3451,"speed":98.2}
    }
  • 參數名 必需 類型 說明
    valuetruejsonjson
    {
    	"value": {...}
    }

請求實例

  • CURL
  • 數值型傳感器和gps型傳感器, <key>為所要更新數據的時間戳(ISO 8601格式).

    curl --request PUT --data-binary @datafile.txt 
    	--header "U-ApiKey: YOUR_API_KEY_HERE" 
    		http://api.yeelink.net/v1.0/device/12/sensor/3/datapoint/2012-03-15T16:13:14

    泛型傳感器, <key>為用戶自定義的字符串, 在請求的URL中需要做urlencode.

    curl --request PUT --data-binary @datafile.txt 
    	--header "U-ApiKey: YOUR_API_KEY_HERE" 
    		http://api.yeelink.net/v1.0/device/12/sensor/3/datapoint/2012-03-15T16:13:14

    微博抓取器不支持;

    Note:只需將要修改的數據值放到datafile.txt中,需要在HTTP Header中增加API Key來授權寫入操作, 具體請參照API Key.

查看數據點

對該URL的請求返回指定key的datapoint, 若未指定key, 則返回該sensor的最新數據.

URL

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

請求參數

參數名必需類型說明
device_idtruestring設備ID
sensor_idtruestring傳感器ID
keytruestring數值和GPS型為數據的時間戳,泛型為自定義字符串

Method

GET

返回值

請求的傳感器信息

返回值數據格式

JSON

返回值數據格式說明

添加Key

  • 數值型傳感器
  • gps型傳感器
  • 泛型傳感器
  • 微博抓取器
  • {
      "value": 39.4
    }
  • {
     "value": {"lat":35.4321,"lng":46.3451,"speed":98.2}
    }
  • {
     "value": {...}
    }
  • 參數名必需類型說明
    status_cnttrueint未讀微博數
    follower_cnttrueint新增好友數
    msg_cnttrueint新消息數
    {
      "status_cnt":0,"follower_cnt":0,"msg_cnt":0
    }

未添加Key

  • 數值型傳感器
  • gps型傳感器
  • 泛型傳感器
  • {
    	"timestamp":"2012-03-15T16:13:14",
    	"value": 39.2
    }
  • {
    	"timestamp":"2012-03-15T16:13:14",
    	"value": {"lat":35.4321,"lng":46.3451,"speed":98.2}
    }
  • {
    	"key":"e10adc3949ba59abbe56e037f20f884e",
    	"value": {...}
    }

訪問授權

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

請求實例

  • CURL
  • Note:對于數值型傳感器和gps型傳感器, <key>為所要查看數據的時間戳(ISO 8601格式).

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

    Note:對于泛型傳感器, 為用戶自定義的字符串, 在請求的URL中需要做urlencode.

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

    Note:微博抓取器 不支持參數key;

刪除數據點

URL

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

Note:對該URL的一個HTTP DELETE請求將刪除指定<key>的數據, 其中<sensor_id>為所要刪除的數據所屬傳感器的id,<device_id>為所要刪除的數據所屬設備的id. 若您的客戶端不支持DELETE請求, 請使用url方式模擬, 具體參照模擬PUT, DELETE請求.

Method

DELETE

返回值

HTTP Headers only

數據格式

JSON

數據格式說明

參數名必需類型說明
device_idtruestring設備ID
sensor_idtruestring傳感器ID
keytruestring數值和GPS型為數據的時間戳,泛型為自定義字符串

訪問授權

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

請求實例 (運用curl):

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

    Note:對于數值型傳感器和gps型傳感器, <key>為所要更新數據的時間戳(ISO 8601格式).

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

    Note:對于泛型傳感器, <key>為用戶自定義的字符串, 在請求的URL中需要做urlencode.

澳洲幸运8中国体育彩票