API 授權憑證

API 授權憑證為用戶登陸的 token，可以通過小程序的 props 來獲得。

token 可以放在請求的 headers 或者 body 或者 query 里面

eg.

curl -H 'X-REQUEST-TOKEN: token' you-api-url

eg.

curl -d 'token=token' you-api-url

eg.

curl you-api-url?token=token

獲取實時數據

GET /api/devices/:uuid/telemetry/

• query 時間區間 after now - 7d, between "2015-01" and "2015-02", before '2018'
• fields 查詢函數或點 last(), *
• columns 查詢規則或字段 .*, some_key, some_key1|some_key2
• multi 多字段查詢 true, false

獲取設備信息

GET /api/devices/:uuid/

更改設備信息

POST /api/devices/:uuid/meta/

• meta 設備信息 JSON 字符串 {"name": "the_name"}

RPC 通訊

POST /api/devices/:uuid/rpc/

• data 請求指令 {"method": "switch_on", "index": 1}
• format 返回的數據格式 json, raw
• timeout 超時時間 300

Websockets 實時數據推送

/feed/:uuid/ws/?token=you_token

JSON 格式的實時數據

添加下行指令

只對使用HTTP/HTTPS接入的設備有效

POST /api/devices/:uuid/downlink/

• body 為指令內容

curl https://iot.giveyun.com/api/devices/my_uuid/downlink/ \
    -H 'Content-Type: application/json' \
    -H 'X-REQUEST-TOKEN: my_user_token' \
    -d '{"method": "open"}'

查看待下發的下行指令

只對使用HTTP/HTTPS接入的設備有效

GET /api/devices/:uuid/downlinks/

curl https://iot.giveyun.com/api/devices/my_uuid/downlinks/ \
    -H 'X-REQUEST-TOKEN: my_user_token'

刪除待下發的下行指令

只對使用HTTP/HTTPS接入的設備有效

DELETE /api/devices/:uuid/downlink/:id/

curl https://iot.giveyun.com/api/devices/my_uuid/downlink/1/ \
    -H 'X-REQUEST-TOKEN: my_user_token' \
    -XDELETE