Advanced Integrated Visibility 運作方式
Advanced Integrated Visibility Webhook 總覽
透過 Advanced Integrated Visibility Webhook,FedEx 可針對與指定 FedEx 帳號連結的貨件,將近乎即時的追蹤事件資料安全推送到特定目的地網址。
若要使用此功能,FedEx 管理員或 DI 管理員必須建立 Advanced Integrated Visibility Webhook 專案。
導覽選項
您可以使用兩種方式存取 Advanced Integrated Visibility Webhooks 頁面:
選項 1:透過「我的專案」
- 從左側導覽面板進入「我的專案」。
- 按一下「Webhook」索引標籤。
選項 2:透過 API 目錄
- 從左側導覽面板進入「API 目錄」。
- 使用搜尋列尋找 Advanced Integrated Visibility,或從「篩選器」部分選取。
- 在 Webhook 卡片上,選擇下列選項之一:
- 按一下「文件」→ 然後按一下「+ 管理 Webhook」
檢視 Advanced Integrated Visibility 追蹤號碼訂閱專案
1. FedEx 個人存取權與設定
- FedEx 管理員或 FedEx 業務代表會啟動設定程序。
- 組織設定檔由指定的管理員代表 CSP 客戶建立。
- 管理員代表客戶,在組織層級新增符合條件的美國帳單帳戶。
- 執行此設定的管理員必須擁有適當權限,可管理組織層級配置。
2. 查看追蹤號碼訂閱的工作流程
2.1 查看訂閱
- FedEx 管理員或代表建立專案之後,使用者即可在其儀表板內檢視相關聯的 Advanced Integrated Visibility – 追蹤號碼訂閱專案。
2. 檢視功能
- 使用者可以探索與訂閱專案相關的可用功能,進一步理解和使用。
功能說明
| 資料欄名稱 | 說明 |
|---|---|
| 送達證明 | 確認貨件已成功送達。內容包括:
|
| 預估送達日期 | 提供以下資訊,協助收件人進行規劃:
|
| 查詢事件 | 可選取一個或多個事件類別來接收通知:
|
「詳細資料」頁面上,將顯示以下資訊:
| 資料欄名稱 | 說明 |
|---|---|
| Webhook 專案名稱 | Webhook 專案的專屬名稱,不可留空。系統會自動填入建議名稱,但您可以編輯。此名稱不得與任何其他 Webhook 重複。 |
| 目的地 URL | FedEx 傳送追蹤事件資料時,所使用的安全 HTTPS 端點。 要求:
|
| 安全性權杖 | 透過 HMAC 驗證身分及 Webhook 回應時,所用的共用密碼。 要求:
|
| 承載語言 (國家/地區) | 請從下拉清單中選取追蹤資料翻譯的偏好語言。 |
| 追蹤類型 | 選擇追蹤資料的傳送方式:
|
| 電子郵件 | 請提供有效電子郵件地址,以便接收通知。 |
| 電子郵件語言 (國家/地區) | 請選取電子郵件通知的偏好語言。 注意:僅支援美國地區語系 (例如 en-US、es-US)。 |
逐步程序
4. 建立訂閱專案
- 請按照上一節中所述的步驟操作,或參閱「開始使用指南」。
5. 產生 OAuth 權杖
- 您需要 OAuth 權杖才能進行 API 呼叫。
- 請使用授權 API 來產生權杖。
- 請參考 API 目錄中的授權 API 文件,瞭解詳細步驟。
6. 存取 API 文件
- 在左側的導覽選單中,按一下「專案詳細資料」。
- 在「生產金鑰」索引標籤底下,捲動尋找 Advanced Integrated Visibility Tracking Number Subscription API 文件。
API 端點總覽
| 端點 | 目的 |
|---|---|
| 追蹤號碼關聯 | 從 Webhook 訂閱新增或移除追蹤號碼。此為非同步工作。回應中會回傳工作識別碼。 |
| 追蹤號碼工作詳細資料 | 提供特定工作識別碼的詳細資料,例如已成功新增或仍在處理中的追蹤號碼數量。 |
| 追蹤號碼工作狀態 | 傳回目前正在處理的所有工作的摘要。 |
使用步驟 2 產生的 OAuth 權杖搭配追蹤號碼關聯端點,將追蹤號碼新增至您的 Webhook。
驗證規則
- Webhook 名稱不得重複。
- 目的地網址必須採用標準語法格式。
- 所有必填欄位都必須填寫。
- 必須與至少一個有效的 FedEx 託運帳號建立關聯。
驗證結果
| 狀態 | 詳細資料 |
|---|---|
| 成功 | 顯示確認訊息: 「<> 已成功建立。變更可能需要 10 分鐘才會生效。」 |
| 未成功 | 如果 FedEx 收到 200 (確定) 或 202 (已接受) 以外的回應,Webhook 目的地網址驗證即視為失敗。 |
Response