此頁面由英文翻譯而成。英文版為官方權威來源。如翻譯內容有任何不一致之處,請以英文版為準。
環境
Flex Forward API 提供兩個環境,分別用於正式營運和開發測試。可用環境
所有請求必須使用 HTTPS。透過 HTTP 發送的請求將被拒絕。
開發環境
開發環境連接至物流業者的沙盒服務(如 YunExpress 沙盒)。適用於:- 在不建立實際配送的情況下測試您的整合
- 驗證請求格式和回應處理
- 開發錯誤處理和重試邏輯
沙盒物流業者服務可能回傳模擬的追蹤資料和標籤文件。回應時間和可用的追蹤狀態可能與正式環境不同。
沙盒測試資料
開發環境支援產生可預測追蹤回應的測試值。使用這些來驗證您的整合能正確處理不同的配送結果:測試值和模擬回應可能會變更。如需最新的沙盒測試資料,請聯繫 Flex Forward 團隊。
認證資訊分離
每個環境請使用個別的 API 令牌。請勿在開發環境中使用正式認證資訊,反之亦然。兩組認證資訊都由您在使用者入口網站自行建立與管理;Flex Forward 不會核發或輪替它們。認證資訊最佳實踐
- 將令牌存放在環境變數或密鑰管理器中
- 切勿在原始碼中寫死令牌或將其提交至版本控制
- 每個環境使用個別令牌,以防止開發期間意外發送正式請求
- 當您自己的安全政策需要時,在使用者入口網站重新產生認證資訊;Flex Forward 不會代您輪替或使其過期
速率限制
目前未強制實施速率限制。建議每個帳戶將請求量控制在 每秒 10 個請求 以下。速率限制標頭(X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset)目前不包含在回應中。
所有端點均已宣告帶有 Retry-After 標頭(需等待的秒數)的 HTTP 429 Too Many Requests 回應。請現在就實作對應處理,讓整合在限制正式啟用後不受影響:收到 429 時,暫停 Retry-After 秒後重試同一請求。請參閱錯誤處理。
如果未來引入速率限制,將透過變更記錄提前通知。如需針對高吞吐量整合討論容量規劃,請聯繫 Flex Forward 團隊 [email protected]。
上線檢查清單
從開發環境切換至正式環境前:- 建議:請先在沙盒環境中測試您的整合,開發用認證資訊可從 User Portal 取得
- 正式用 API 金鑰與令牌已從 User Portal(Settings → Signing Key and API Token)取得
- 配送帳戶已設定正式物流業者
- 在開發環境中標籤建立測試成功
- 標籤文件取得已測試
- 追蹤取得已測試
- 冪等性行為已驗證(相同金鑰與本文會重放;變更本文會回傳
IDEMPOTENCY_CONFLICT) - 已實作所有狀態碼的錯誤處理
- 所需物流業者和物流路線設定已確認