Skip to content

API Documentation

qmo1222 edited this page Aug 5, 2017 · 22 revisions

API固定傳入的參數(除了登入與下載)

  • operator_uid:使用者的uid
  • token:投入正確代幣使用API

API固定回傳的參數(除了下載)

  • uid:目標使用者
  • object:目標物件(隊員,任務)
  • action:目標動作
  • brea: API Status
  • server time: 伺服器時間

Brea Value meaning

brea value 意思
0 Correct
1 Database Error
2 Incomplete fields
3 No target value in database
4 Authentication failed
5 Item already in database

隊員

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
登入驗證 /member/login Post v v email, password token (string), correct (bool)
更新死活 /member/liveordie Put v v uid, status status (bool)
更新位置 /member/update Put v uid, position_e, position_n valid_area (bool)
發出緊急狀況 /member/callhelp Put v v uid, position_e, position_n
讀取 /member/read Get v v (uid) 詳見Object
增減錢錢 /member/money Put v uid, money_amount
增減分數 /member/score Put v uid, score

任務

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
新建 /mission/create Post v 詳見Object(除了mid), image(optional) mid (int)
編輯 /mission/edit Put v mid,(要改的東西)
刪除 /mission/delete Del v mid
讀取 /mission/read Get v v (mid) 詳見 Object

備註:前台讀取已開始的任務,後台則讀取所有任務

回報

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
新建 /report/create Post v mid, image rid (int)
審核 /report/check Put v rid, status status (int)
編輯 /report/edit Put v rid, image
取消 /report/delete Del v rid
讀取 /report/read Get v v uid or mid 詳見 Object

道具

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
新增 /tool/create Post v image, Object(除了tid,url) tid (int)
刪除 /tool/delete Del v tid
讀取 /tool/read Get v v (tid) 詳見Object

線索

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
新增 /clue/create Post v content cid (int)
刪除 /clue/delete Del v cid
讀取 /clue/read Get v v (cid) content (string)

背包

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
新增 /pack/create Post v v 詳見Object(除了pid) pid (int)
刪除 /pack/delete Del v v pid
讀取 /pack/read Get v v (uid) 詳見Object

下載

動作 API 路徑 Method 後台 APP端 傳入參數 傳回參數
相片 /download/img/filename Get v
地圖 /download/map/filename Get v v
聯絡人 /utility/squadnumber Get v v squad 詳見API Return Template