REST API 文件

透過此文件,使用者將可以按照文件中提供的資訊將其數據資料透過API傳送到平台上,文件內容定義均根據OpenAPI標準。目前平台只先支援Post和Get method。

以下將以資料格式頁內,所設定的資料為例子來說明。

API 金鑰(Key)和端點(Endpoint)

從上圖右上角紅色圓圈可以找到API 金鑰(Key)和端點(Endpoint),使用者需要這2個資訊來將資料傳送至平台。

POST

點擊從上圖右邊的紫色圓圈的「向下箭頭」,將會顯示如何透過Post將資料來源(此例子為FactoryA)的資料送至平台和其資料的格式結構。另外也可試著在平台上直接通過Curl來傳送資料至平台,詳細請見下方影片。

使用Curl

curl -X 'POST' \
  'https://api.xplatform.tranx.io/staging/FactoryA' \
  -H 'accept: */*' \
  -H 'x-api-key: XHZ56MXXXXXXXXXXXXXXXXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
  "PowerUsage": 10,
  "Temperature": 20,
  "Motor": 1200,
  "Duty": "John"
}'

注意:

  1. API裡的URL會是「{端點}/{資料來源}」。

  2. Key是要放在header中的"x-api-key"。

  3. 當資料送至平台,系統將會記錄當下時間,將其時間寫到資料庫,資料匯出時,也會包含此時間。

GET

如同POST,如下圖一樣點擊「向下箭頭」,將可看到更多使用上的資訊。

接著在點擊按鈕「Try it out」後,請見下圖,也可以輸入時間區段,並按下「Execute」,即可以得到平台上的數據資料。

使用Curl

curl -X 'GET' \
  'https://api.xplatform.tranx.io/staging/FactoryA?startTime=2023-04-03%2010%3A01%3A12.534000000&endTime=2023-04-04%2023%3A59%3A12.534000000' \
  -H 'accept: application/json' \
  -H 'x-api-key: XHZ56MXXXXXXXXXXXXXXXXXXXXXXXX'

注意:輸入時間的格式是UTC時間。

錯誤碼(Error Code)

使用者可以透過回傳的錯誤碼來Debug,以下為Code列表:

200

Success

400

Bad request

403

Invalid API key

404

Source not found

413

Request entity too large

429

Too many requests

最后更新于