Tigerfly API Documents

API Domain: https://api.tigerfly.tw/

User Authentication (身分驗證)

使用者身分的驗證,是以 Authorization 當作欄位,並且使用 Bearer {access_token} 的組合附加在每次的請求的 header 上,以確認使用者的身分。例如 access token 為 2bf1efe7cc51f6eh5ad1c98f05y9s34463ca85ad,那麼在 header 中的格式為

Tfas (系統簡訊)

POST /tfas/send (系統簡訊發送)

https://api.tigerfly.tw/tfas/send

Request

Response

Callback

You will be notified when the status changed if callback_url given.

POST /tfas/search (系統簡訊查詢)

https://api.tigerfly.tw/tfas/search

Request

Response

GET /tfas/report (系統簡訊報表)

https://api.tigerfly.tw/tfas/report

Request

Response

Delivery (超商未取貨)

POST /delivery/upload (上傳未取貨名單)

https://api.tigerfly.tw/delivery/upload

Request

Response

PATCH /delivery/update/{shipping_id}/picked (更新包裹狀態)

https://api.tigerfly.tw/delivery/update/{shipping_id}/picked

Request

Response

GET /delivery/status/{shipping_id} (查詢包裹狀態)

https://api.tigerfly.tw/delivery/status/{shipping_id}

Request

Response

Report (報表)

GET /report/tfam/failed (系統信失敗名單)

https://api.tigerfly.tw/report/tfam/failed

預設提供前一天的失敗名單

Request

Response

Audience (名單上傳)

POST /audience/tfm (行銷信名單上傳)

Request

Response

POST /audience/tfs (行銷簡訊名單上傳)

Request

Response

Tfam (系統信)

POST /tfam/send (系統信發送)

Request

Response

Client-Users (會員)

POST /client-users (批次新增/更新會員)

Request

Response

GET /client-users/{user_id} (單筆查詢會員)

Request

Response

POST /client-users/search (批次查詢會員)

Request

Response

Client-Products (產品)

POST /client-products (批次新增/更新產品)

Request

Response

GET /client-product/{product_id} (單筆查詢產品)

Request

Response

POST /client-product/search (批次查詢產品)

Request

Response

DELETE /client-product/{product_id} (單筆刪除產品)

Request

Response

POST /client-product/delete (批次刪除產品)

Request

Response

Client-Carts (未結購物車)

POST /client-carts (批次新增/更新購物車)

Request

Response

POST /client-carts/search (批次查詢購物車)

Request

Response

DELETE /client-carts/{cart_id} (單筆刪除購物車)

Request

Response

Code reference

Tfas Status Code

Code Description
0 Sent to service provider
1 Service provider accepted
2 Delivered to the phone
3 The number can’t be undelivered
4 Expired
5 Error
99 Undefined

Error Code

HTTP Code

Code Description
400 Invalid parameters or body content
401 Authentication failed
404 Resource not found
429 Too many requests
500 Server error

Detail Error Code

Code Description
400 Invalid parameters or body content for general cases
1101 Empty field
1102 Field exceeded the maximum size limit
1103 Invalid request format
1104 Not found
1106 Too many requests
1201 User upload quota runs out

Global error response