Sandbox Console
測試Webhook
您可使用「測試Webhook網址」功能測試傳回至目的地網址(收件人/聆聽人伺服器)的查詢資料類型。此功能有助在建立「進階集成可見性webhook」前,先驗證傳回的網址和資料。
導覽:
導航至測試Webhook網址沙盒控制台的方法如下:
- 我的項目(位於左側導航選單上)->「進階集成可見性」標籤->「測試webhook網址」按鈕->在沙盒控制台中,點擊試用此「進階集成可見性」
- API目錄(位於左側導航選單上)->在篩選器中搜尋「進階集成可見性」/點擊「進階集成可見性」->「進階集成可見性」卡片:
- ->概覽->「說明文件」按鈕->在沙盒控制台中點擊試用此「進階集成可見性」。
- ->文件->在沙盒控制台中點擊試用此「進階集成可見性」。
步驟:
使用測試Webhook網址功能的步驟如下:
- 點擊測試Webhook網址按鈕。
- 輸入下列測試參數:
欄位名稱 說明 目的地 URL
這是接收查詢事件資料/數據的網址。
- 顧客應提供可用且有效的目的地網址。
- 所提供的目的地網址必須以標準化句法格式提供 (安全的 https 網址)。
安全令牌
用作共用密碼,以授權及驗證「進階集成可見性webhook」回應。
- 令牌的值必須至少有26個字元,最多為100個字元。
- 必須至少有 1 個大寫字母、1 個小寫字母,以及 1 個數字字元。
- 安全令牌將用於建立以雜湊 (hash) 為基礎的訊息授權驗證代碼 (HMAC) 簽名,以作回應驗證之用。
數據語言
從下拉清單選擇查詢數據翻譯的偏好語言。6 種可用的範本語言如下:
- 英文(美國)(預設)
查詢類型
選擇要接收查詢資料的回應類型。
- 詳細查詢回應(回應類型由安全的查詢數據組成,提供事件的完整記錄)。(預設)
- 事件特定查詢回應(回應類型由安全的查詢數據組成,只提供最近期的事件資訊)。(快將推出)
查詢事件
選擇一個高層級類別,以接收與包裹週期中的貨件事件相關的電郵通知。高層級類別如下:
- 託運
- 運送中
- 遞送
- 例外狀況
- 預計送達
狀態事件
包裹週期中的查詢事件。選擇其中一項要接收的查詢事件。10個可用的範本狀態事件如下:
- 已收件
- 運送中
- 已送達
- 未能送達事故
請注意:「狀態事件」欄位值將會根據已選擇的「查詢事件類別」填入。如需進一步了解「查詢事件類別」及其相應的「狀態事件」,請參閱下表。
狀態事件類別 狀態事件 託運
- 已收件
運送中
- 運送中
遞送
- 已送達
例外狀況
- 未能送達事故
預計送達(快將推出)
- 預計送達日期 (EDD)
- 預計送達時間範圍 (EDTW)
- 請勾選 FedEx Developer Portal 授權協議 (FDPLA) 方格,以簽署/接受授權協議。
- 點擊推送按鈕以檢視測試結果。
回應:
沙盒中的回應參數如下:
- 正文 — 正文包含沙盒控制台內測試 Webhook 網址標籤中的回應參數。
- 狀態 — 這個部分位於測試結果標籤中,可提供已處理請求的狀態。
成功訊息範本:
成功
測試「進階集成可見性」查詢事件詳細資訊已成功遞送。
Status
Success
Test webhook tracking event details delivered successfully
Error
Test webhook tracking event details delivery failed
如果測試事件傳送失敗,測試結果標籤中的狀態將顯示為錯誤,並附有相應的錯誤代碼和錯誤訊息。
錯誤訊息範本:
錯誤代碼:<<錯誤代碼>>
測試「進階集成可見性」查詢事件詳細資訊傳送失敗。
驗證規則:
- 「進階集成可見性」網址必須為標準化句法格式。
- 測試「進階集成可見性」網址的所有必填欄位均不得為空。
- 驗證成功:
- FedEx 將會傳送附有範本事件 JSON 的請求。 請注意:「進階集成可見性」目的地網址應會以200(確定)的HTTP狀態代碼回應FedEx。
- 驗證不成功/失敗:
- 如果FedEx收到任何200(確定)以外的回應,「進階集成可見性」目的地網址驗證將視同失敗。
- FedEx 將會在測試結果標籤中顯示錯誤代碼和錯誤訊息。
數據計算器
數據計算器經專門設計,可幫助用戶估算透過webhook活動生成的數據量。用戶利用此工具,可清晰了解每日數據大小、貨件數量及查詢事件數量,以在數據使用情況和整合規劃方面作出明智決定。
使用計算器
用戶可輸入下列參數:
- 貨件數量
- 每件貨件的事件數量(預設:5)
- 每日數據量(自動計算)
計算器會根據這些輸入,以動態方式顯示:
- 查詢事件總數
- 每日數據
- 預計數據總大小
參考備註:
- 每件貨件的事件數量預設為5。此數值乃根據每件貨件平均17至18個事件,以及一般1至7天的送達時間而得出,並會視乎服務類型、貨運公司和目的地而有所不同。假設平均送達時間為3天。請注意:用戶可編輯此數值。
- 每日數據量的計算方法為:貨件數量×每件貨件的事件數量(預設:5)
- 用戶只需輸入貨件數量,然後點擊「計算」即可生成結果。其他數值為預設或自動計算。
免責聲明:計算器提供的所有數值均為大約值,僅供規劃之用。
Response