總覽
透過 Advanced Integrated Visibility Webhook,FedEx 可針對與一組或多組 FedEx 帳號建立關聯的貨件,將近乎即時且安全的追蹤事件資料推送到特定目的地網址。只要在 FedEx Developer Portal 建立 Webhook 專案,即可存取這項功能。
導覽路徑
您可以透過下列任一方式存取 Webhook 建立頁面:
- 我的專案:依序點選左側「導覽面板」→「Webhook」索引標籤 →「+ 建立 Webhook 專案」
- API 目錄:
- 依序點選左側「導覽面板」→「API 目錄」
- 搜尋或篩選「Advanced Integrated Visibility」
- 依序點選「總覽」→「文件」→ 沙箱主控台中的「+ 建立專案」
- 依序按一下「文件」→「+ 建立 Webhook」
Webhook 建立步驟
步驟 1:選取公司類型
按一下「+ 建立專案」,然後從下拉清單中選擇公司類型:
- 使用 FedEx 託運,且需要將 FedEx Webhook 整合至公司系統。
- 銷售或提供使用 FedEx 資料的軟體解決方案,而且並未獲得 FedEx 電商兼容供應商認證。
- 是經認證的 FedEx 電商兼容供應商。
附註:目前 FedEx Advanced Integrated Visibility Webhook 解決方案無法用於此選項。身為 FedEx 電商兼容計畫的成員,若您想存取 Basic Integrated Visibility 或其他 FedEx 整合解決方案,請聯絡您的通路管理員。如果不清楚通路管理員是誰,請聯絡您的公司管理員。
接著,選取「Advanced Integrated Visibility 帳號訂閱」為訂閱類型。
建立 Advanced Integrated Visibility 帳號訂閱
建立流程分為四個關鍵步驟:
步驟 1:啟用 Advanced Integrated Visibility 帳號訂閱
此步驟需經第三方客戶提出要求,再由 FedEx 管理員或 FedEx 業務代表處理。
- MNDA 文件:FedEx 管理員或 FedEx 業務代表會收集雙方同意的保密合約 (MNDA) 和第一方/託運公司帳號的批量清單。
附註:本次上傳過程中可提供已與其他組織關聯的重複帳號。
- 如適用,系統會在組織層級啟用自訂價格。
附註:這項功能未包含在 July Experience 內。
步驟 2:+ 建立專案
在「選取產品」頁面中:
- 按一下「Advanced Integrated Visibility – 帳號」,然後點選「下一步」。
- 選取「帳單帳戶」,接受付款條款,然後點選「下一步」。
至少須新增一個帳單帳戶。
在「確認詳細資料」頁面中:
- 檢查專案資訊。
- 接受《條款及細則》。
- 如果適用自訂價格,相關文件會自動顯示。
成功建立後,系統會顯示確認訊息:
「您已成功在『我的專案』中新增產品。」
步驟 3:專案總覽 – API 金鑰啟用程序
- 前往「專案總覽」頁面,在「API」專區的「API 金鑰」索引標籤下方,訂閱的生產環境狀態最初會顯示為「停用」。
- 收到要求後,FedEx 管理員或業務代表會啟用產品。
- 啟用後,「生產金鑰」索引標籤便會開放存取,生產環境狀態也會更新為「待確認」。
- FedEx 管理員或業務代表完成最終啟用後,生產環境狀態會改為「啟用」。
步驟 4:專案總覽 – 設定 Webhook
- 前往「專案總覽」頁面。
- 選取「Webhook」索引標籤。
- 按一下「+ 設定 Webhook」按鈕開始設定。系統會重新導向至「Webhook」索引標籤。
功能說明
| 資料欄名稱 | 說明 |
|---|---|
| 送達證明 | 確認貨件已成功送達。包括: 圖片簽收證明 (PPOD):提供顯示確切送達地點的照片。 簽收證明 (SPOD):提供具有收件人簽章與其姓名、送達日期、時間及地點的影像。 |
| 預估送達日期 | 提供以下資訊,協助收件人規劃收件: 預估送達日期 (EDD) 預估送達時間範圍 (EDTW) |
| 查詢事件 | 允許選取要接收通知的一個或多個事件類別: 託運 運送中 遞送 例外狀況 自訂遞送選項 |
| 事件型篩選 | 依以下條件篩選 Webhook 回應: 進口貨件 出口貨件 第三方貨件 |
2. 在「輸入詳細資料」頁面提供以下資訊:
| 資料欄名稱 | 說明 |
|---|---|
| Webhook 專案名稱 | Webhook 專案的專屬名稱,不可留空。系統會自動填入建議名稱,但您可以編輯。此名稱不得與任何其他 Webhook 重複。 |
| 目的地 URL | FedEx 傳送追蹤事件資料時,所使用的安全 HTTPS 端點。 要求: 必須有效且正常運作 必須採用標準語法 不得包含 fedex.com 或其子網域 可重複用於多個 Webhook 如需詳細資料,請參閱「商務規則與最佳做法」一節。 |
| 安全性權杖 | 透過 HMAC 驗證身分及 Webhook 回應時,所用的共用密碼。 要求: 26 至 100 個半形字元 必須包含至少 1 個大寫字母、1 個小寫字母和 1 個數字字元 可重複用於多個 Webhook |
| 承載語言 (國家/地區) | 請從下拉清單中選取追蹤資料翻譯的偏好語言。 |
| 追蹤類型 | 選擇追蹤資料的交付方式 詳細追蹤資料 – 完整事件記錄 特定事件追蹤資料 – 僅限最近的事件 |
| 電子郵件 | 請提供有效電子郵件地址,以便接收通知。 |
| 電子郵件語言 (國家/地區) | 請選取電子郵件通知的偏好語言。 附註:僅支援美國地區語系 (例如 en-US、es-US)。 |
步驟 3:選擇託運帳戶
在「選擇託運帳戶」頁面中:
選取一或多個 FedEx 帳號,與您的 Webhook 專案建立關聯。
重要事項:
清單中只會顯示尚未與其他 Webhook 建立關聯的帳戶。
必須與至少一個帳戶建立關聯,才能繼續操作。
最多可透過 Webhook UI 新增 100 個帳戶。
如要與 超過 100 個帳戶建立關聯,請使用 Webhook API。
如欲申請 API 存取權,請聯絡 FedEx 顧客支援或服務台。
步驟 4:確認詳細資料並建立專案
在「確認詳細資料」頁面中:
1. 檢查所有已輸入的 Webhook 專案資訊。
2. 勾選「接受條款及細則」方塊。
3. 按一下「建立」,完成 Webhook 設定。
成功提交資訊後即可建立 Webhook,系統會產生訂閱識別碼,並將 Webhook 狀態設為「啟用」。
驗證規則
一般要求:
「Webhook 名稱」不得重複。
「目的地網址」須採用標準語法格式 (安全 HTTPS,不含 fedex.com 或其子網域)。
所有必填欄位均須妥善填寫,不得留空。
Webhook 必須與至少一個有效的 FedEx 託運帳號建立關聯。
驗證成功:
如果成功建立 Webhook,客戶會收到以下確認訊息:
<<Webhook 名稱>> 已成功建立。變更可能需要 10 分鐘才會生效。
驗證未成功/失敗:
如果 FedEx 從目的地網址收到 HTTP 200 (確定) 或 202 (已接受) 以外的任何回應,Webhook 驗證即視為失敗。
Response