Home

配置

1. 環境變數：examples/settings.json↩ 中有環境變數的設置範例，會被 settings.py↩ 引用，可以手動加入或直接在該檔案的對應位置做修改。JSON檔並不會被匯入成環境變數。
2. 新增管理用使用者： User↩ 內新增一個使用者，設定好它的 type 以在 API 認證時使用 (似乎是可以用 admin 套件但是需要補上蠻多的 code。
3. (待補...

API 文件

慣例

所有請求均使用 POST request，回傳為JSON。POST data 可以用 form data (application/x-www-form-urlencoded) 或 JSON (application/json) 格式，均必須接受兩個參數：token (api_key, 於環境設定時配置) 與版本編號 (version，預設為 1)。若必要參數未給全，錯誤訊息為 415 INVAILD PARAMETER。

成功與失敗的回傳格式範例如下：

{"status": "success", "timestamp": "..."}
{"status": "error", "reason": "unauthorized"}

錯誤

錯誤訊息可以由 HTTP status code 或錯誤訊息的 reason 得知，在 log 中亦有詳細紀錄可以參考。

API 端點

(待補)

api/station/register

api/station/ping

api/authenticate

api/confirm

api/report