p6p
8/29/2015 - 7:47 AM

Travor.md

Travor.md
content_copyfile_download
  • Rendered
  • Source

Travor API Document

Get User Data

get session

GET /api/session

Implementation Notes

用於獲得已存在用戶的 Session ID

Parameters
  • email
  • password
Response Messages
  • 200 // 成功獲得返回 Session ID
  • 401 // 失敗並返回詳細訊息
Return Type
{}

create user

POST /api/user

Implementation Notes

建立新用戶

Parameters
  • email
  • password
  • phone_number // 手機號碼
  • gender // 傳入 [F|M]
  • name // 真實姓名
Response Messages
  • 200 // 成功建立返回 Session ID
  • 401 // 失敗並返回詳細訊息
Return Type
{}

show user detail

GET /api/user

Implementation Notes

用於顯示用戶詳情頁

Parameters

fields // 返回的欄位，以 , 進行分割，枚舉值參考附表

Response Messages
  • 200 // 成功返回資料
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

update user detail

PATCH /api/user

Implementation Notes

更新現有用戶資料

Parameters
  • email
  • password
  • phone_number // 手機號碼
  • gender // 傳入 [F|M]
  • name // 真實姓名
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

update user password

PATCH /api/user/password

Implementation Notes

更新用戶密碼

Parameters
  • old_password
  • email_token
  • new_password
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

modify forgeted password

PATCH /api/user/forget_password

Implementation Notes

忘記密碼，限制每一分鐘請求最多一次

Parameters
  • email
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 404 // 無此信箱
Return Type
{}

verify email

PATCH /api/user/verify_email

Implementation Notes

驗證 email

Parameters
  • token
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
Return Type
{}

verify celephone

PATCH /api/user/verify_phone

Implementation Notes

驗證手機

Parameters
  • token
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
Return Type
{}

訂單

create case

POST /api/case/create

Implementation Notes

建立新的訂單以及 +1

Parameters
  • name
  • country
  • content
  • weight
  • volume
  • price
  • images
Response Messages
  • 200 // 成功返回商品 id
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

get case list

GET /api/cases

Implementation Notes

獲得或搜尋現有訂單列表

Parameters
  • own_cases // 用戶自己的 cases ，傳入 [Buyer|Seller]
  • country // 傳入代號
  • keyword // 用戶輸入的關鍵字
  • sort // 排序規則
  • weight_max // 重量最大值，單位為 g
  • volume_max // 體積最大值，單位為 L
  • fields // 參考附表
  • limit // cases 總數
  • offset // 從 0 開始計數
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 404 // 無符合查詢
Return Type
{}

update case

PATCH /api/case/:id

Implementation Notes

更新已存在的訂單、接單，藉由 Session ID 判斷其狀況

Parameters
  • accept_
  • name
  • country
  • content
  • weight
  • volume
  • price
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

accept case

PATCH /api/case/:id/accept

Implementation Notes

更新已存在的訂單

Parameters
  • leave_date // 出國日期，傳入 1970 開始秒數
  • back_date // 回國日期，傳入 1970 開始秒數
Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

delete case

DELETE /api/case/:id

Implementation Notes

取消訂單

Parameters

None

Response Messages
  • 200 // 成功
  • 401 // 失敗並返回詳細訊息
  • 403 // 權限不足
Return Type
{}

get case detail

GET /api/case/:id

Implementation Notes

獲得訂單詳細資訊

Parameters
  • fields // 返回的欄位，以 , 進行分割，枚舉值參考附表
Response Messages
  • 200 // 成功回回傳
  • 401 // 失敗並返回詳細訊息
  • 404 // 無此商品
Return Type
{}

Get Asset

  • /assert/scripts/{hash}.js
  • /assert/stylesheets/{hash}.css
  • /assert/images/{hash}.[jpg|png|gif]

Get User Detail Fields

  • name
  • phone_number
  • gender
  • name

Get Case Detail Fields

  • name
  • country
  • content
  • weight
  • volume
  • price
  • is_payed
  • images