Advanced Integrated Visibility 運作方式
Advanced Integrated Visibility Webhook 讓 FedEx 將安全且近乎即時的追蹤更新傳送至特定網址。這些更新適用的貨件,是與一個或多個 FedEx 帳號連結的貨件。若要使用此功能,您必須建立 Advanced Integrated Visibility Webhook 專案。
存取 Advanced Integrated Visibility 頁面的方式
您可以使用兩種方式進入 Advanced Integrated Visibility 設定:
選項 1:透過「我的專案」
1. 在左側導覽面板中,前往「我的專案」。
2. 按一下「Webhook」索引標籤。
3. 選擇「+建立 Webhook 專案」。
選項 2:透過 API 目錄
1. 從左側導覽面板開啟「API 目錄」。
2. 搜尋 Advanced Integrated Visibility。
3. 使用 WEBHOOK 篩選器來尋找正確的卡片。
4. 在卡片上:
- 按一下「總覽」,再按一下「文件」按鈕,然後選擇「+建立 WEBHOOK 專案」。
- 或前往「文件」,然後按一下「+建立 WEBHOOK 專案」。
步驟 1:選取公司類型
按一下「+建立專案」,然後從下拉清單中選擇公司類型:
1. 使用 FedEx 託運,且需要將 FedEx Webhook 整合至公司系統。
2. 銷售或提供使用 FedEx 資料的軟體解決方案,而且並未獲得 FedEx 電商兼容供應商認證。
3. 是經認證的 FedEx 電商兼容供應商。
接著,選取「Advanced Integrated Visibility 追蹤號碼訂閱」做為訂閱類型。
建立 Advanced Integrated Visibility 追蹤號碼訂閱
您可以設定 Advanced Integrated Visibility 追蹤號碼訂閱,為一個或多個 FedEx 追蹤號碼接收安全、近乎即時的追蹤更新。這些更新會傳送至您指定的目的地網址。
建立訂閱的步驟
此流程共有四個主要步驟:
1. 設定專案
2. 輸入專案詳細資料
3. 確認詳細資料並接受條款
4. 新增追蹤號碼
逐步說明
1. 在「設定 Webhook」頁面中:
確認帳單帳戶
會顯示您組織的預設帳單帳戶。
如要變更:
- 按一下「新增帳單帳戶至您的組織」(如果只有一個帳戶),或者
- 按一下「選取另一個帳單帳戶」(如果有多個帳戶)。
附註:如需定價詳細資料,請前往「Advanced Integrated Visibility 總覽」頁面。
2. 選取功能
- 選擇您需要的功能。
- 按一下「下一步」繼續。
提示:若要深入瞭解各項功能,請按一下功能旁的說明圖示 (?)。
功能說明
| 資料欄名稱 | 說明 |
|---|---|
| 送達證明 | 確認貨件已成功送達。內容包括:
|
| 預估送達日期 | 提供以下資訊,協助收件人規劃收件:
|
| 查詢事件 | 允許選取一或多個要接收通知的事件類別:
|
在「輸入詳細資料」頁面,提供以下資訊:
| 資料欄名稱 | 說明 |
|---|---|
| Webhook 專案名稱 | Webhook 專案的專屬名稱,不可留空。系統會自動填入建議名稱,但您可以編輯。此名稱不得與任何其他 Webhook 重複。 |
| 目的地 URL | FedEx 傳送追蹤事件資料時,所使用的安全 HTTPS 端點。 要求:
|
| 安全性權杖 | 透過 HMAC 驗證身分及 Webhook 回應時,所用的共用密碼。 要求:
|
| 承載語言 (國家/地區) | 請從下拉清單中選取追蹤資料翻譯的偏好語言。 |
| 追蹤類型 | 選擇追蹤資料的傳送方式:
|
| 電子郵件 | 請提供有效電子郵件地址,以便接收通知。 |
| 電子郵件語言 (國家/地區) | 請選取電子郵件通知的偏好語言。 附註:僅支援美國地區語系 (例如 en-US、es-US)。 |
3. 在「確認詳細資料」頁面中:
- 檢視您的 Webhook 專案詳細資料。
- 確認並接受條款及細則。
- 按一下「建立」,完成 Webhook 專案設定。
4. 當您的請求成功送出後:
- FedEx 會建立一個新的 Webhook 專案。
- 您會收到 Advanced Integrated Visibility Tracking Number Subscription API 的生產金鑰。
- 您可以用此 API,將追蹤號碼與您的專案建立關聯。
若要深入瞭解,請參閱 Advanced Integrated Visibility Tracking Number Subscription API 文件頁面。
如何將追蹤號碼新增至 Webhook
若要使用 Advanced Integrated Visibility Tracking Number Subscription API 將追蹤號碼新增到您的 Webhook 訂閱,請進行以下步驟:
逐步程序
1. 建立訂閱專案
請按照上一節中所述的步驟操作,或參閱「開始使用指南」。
2. 產生 OAuth 權杖
- 您需要 OAuth 權杖才能進行 API 呼叫。
- 請使用授權 API 來產生權杖。
- 請參考 API 目錄中的授權 API 文件,瞭解詳細步驟。
3. 存取 API 文件
- 在左側的導覽選單中,按一下「專案詳細資料」。
- 在「生產金鑰」索引標籤底下,捲動尋找 Advanced Integrated Visibility Tracking Number Subscription API 文件。
API 端點總覽
| 端點 | 目的 |
|---|---|
| 追蹤號碼關聯 | 從 Webhook 訂閱新增或移除追蹤號碼。此為非同步工作。回應中會回傳工作識別碼。 |
| 追蹤號碼工作詳細資料 | 提供特定工作識別碼的詳細資料,例如已成功新增或仍在處理中的追蹤號碼數量。 |
| 追蹤號碼工作狀態 | 傳回目前正在處理的所有工作的摘要。 |
使用步驟 2 產生的 OAuth 權杖搭配追蹤號碼關聯端點,將追蹤號碼新增至您的 Webhook。
驗證規則
- Webhook 名稱不得重複。
- 目的地網址必須採用標準語法格式。
- 所有必填欄位都必須填寫。
- 必須與至少一個有效的 FedEx 託運帳號建立關聯。
驗證結果
| 狀態 | 詳細資料 |
|---|---|
| 成功 | 顯示確認訊息: 「<> 已成功建立。變更可能需要 10 分鐘才會生效。」 |
| 未成功 | 如果 FedEx 收到 200 (確定) 或 202 (已接受) 以外的回應,Webhook 目的地網址驗證即視為失敗。 |
Response