API

PieceCloud是一個物聯網的服務平台.PieceCloud提供了一個簡而易用的裝置聯網方案.

PieceCloud目前提供了控制與資料存取的服務,透過PieceCloud的API,將可以迅速地把PieceDuino與PieceCloud串連起來,並可搭配各種第三方的軟硬體,幫助使用者來迅速地開發出屬於自己的產品原型.

為了讓使用者能快速地上手,PieceCloud選了最常用的功能,並將之簡化為四支API,如下 :

PieceCloud Token

當你使用到PieceCloud的任何API時,你將會需要一組我們稱為PieceCloud Token的金鑰,來作為操作的憑證.
取得PieceCloud Token的方法很簡單,請到帳號管理頁面申請一組帳號,接著再進入PieceCloud頁面,系統將會隨機產生一組專屬您的PieceCloud Token.

 


 

連接方式

PieceCloud API 是HTTP API,所以需要透過API Address來進行連接與溝通.
位址如下 :

API Address: http://api.pieceduino.com/

 


 

API 使用說明

訊號遠端控制

範例 http://api.pieceduino.com/?action=cData&token=xxx&key=xxx&value=xxx
Request
傳值方式 POST , GET
連結位址 http://api.pieceduino.com/?action=cData
輸入參數 (必) string $key:控制鍵值
(必) string $value:控制數值
(必) string $token:會員帳號憑證
(選) string $to:目標裝置

Response
資料格式 {

“status”:”success”,

“message”:”send cmd complete”

}

資料說明 status:處理結果

  • success:成功
  • fail:失敗

message:處理結果訊息

儲存資料

範例 http://api.pieceduino.com/?action=sData&token=xxx&xxx=xxx
Request
傳值方式 POST , GET
連結位址 http://api.pieceduino.com/?action=sData
輸入參數 (必) string $token:會員帳號憑證
(必) KeyValueSet:最少需要一組鍵值

Response
資料格式 {

“status”:”success”,

“message”:”save data complete”

}

資料說明 status:處理結果

  • success:成功
  • fail:失敗

message:處理結果訊息

取得資料

範例 http://api.pieceduino.com/?action=gData
&token=xxx
&stime=2015/8/27%204:24:32
&etime=2015/8/29%204:24:32
&mode=-1
&tfield=xxx
Request
傳值方式 POST , GET
連結位址 http://api.pieceduino.com/?action=gData
輸入參數 (必) string $token:會員帳號憑證
(選) string $stime:資料篩選開始時間
(選) string $etime:資料篩選結束時間
(選) string $mode:排序模式 1: ASC 舊至新,-1:DESC 新至舊
(選) string $tfield:目標鍵值篩選
(選) string $skip:從起始跳過n筆
(選) string $limit:總筆數限制

Response
資料格式 {

“status”:”success”,

“message”:”get data complete”

}

資料說明 status:處理結果

  • success:成功
  • fail:失敗

message:處理結果訊息

取得目前憑證所有上線端

範例 http://api.pieceduino.com/?action=get_clientList&token=xxx
Request
傳值方式 POST , GET
連結位址 http://api.pieceduino.com/?action=get_clientList
輸入參數 (必) string $token:會員帳號憑證

Response
資料格式 {

“status”:”success”,

“message”:”列表取得成功”,

“pieceduino”:[

“69usSky8XZpL61NcAAAR”,

“b3_QbQ_yS-2oG5XBAAAZ”

],

“web”:[

“E5BiIsdQi6GAbSZNAAAT”,

“olwE5GERWfQZjQZQAAAY”

] }

資料說明 status:處理結果

  • success:成功
  • fail:失敗

message:處理結果訊息