「進階集成可見性」的運作原理
「進階集成可見性webhook」概覽
「進階集成可見性webhook」讓FedEx能夠透過安全方式,將與指定FedEx帳號連結之貨件之近乎實時的查詢事件數據推送至特定的目的地網址。
如需使用此功能,FedEx管理員或DI管理員必須建立「進階集成可見性」webhook項目。
導覽選項
您可透過兩種方式,存取「進階集成可見性webhook」頁面:
選項1:透過「我的項目」
- 從左側導覽選單,導覽至「我的項目」。
- 點擊「Webhook」索引標籤。
選項2:透過「API目錄」
- 從左側導覽選單前往API目錄。
- 使用搜尋欄尋找「進階集成可見性」,或者從「篩選器」部分選擇。
- 在Webhook卡片上,選擇下列其中一項:
- 點擊「文件」→ 然後點擊「+管理Webhook」
檢視「進階集成可見性查詢號碼訂閱項目」
1. FedEx個人存取及設置
- FedEx管理員或FedEx代表將會發起設置流程。
- 指定管理員會代表CSP顧客,建立組織設定檔。
- 管理員會代表顧客,在組織層級新增位於美國的合資格付款帳號。
- 執行此設置的管理員必須擁有適當的權限,方可管理組織層級的配置。
2. 檢視「查詢號碼訂閱」的工作流程
2.1 檢視訂閱
- FedEx管理員或代表建立項目後,用戶可在圖表板中檢視相關聯的「進階集成可見性 – 查詢號碼訂閱項目」。
2. 檢視功能
- 用戶可探索與訂閱項目相關聯的可用功能,以深入了解及善用它們。
功能說明
| 欄位名稱 | 說明 |
|---|---|
| 送達證明 | 確認貨件已成功送達。包括:
|
| 預計送達 | 提供以下各項,協助收件人規劃安排:
|
| 查詢事件 | 允許選擇一個或以上的事件類別,以接收通知:
|
「詳情」頁面上將會顯示下列資料:
| 欄位名稱 | 說明 |
|---|---|
| Webhook 項目名稱 | 為您的webhook項目輸入唯一且不可為空的名稱。系統會自動填入建議名稱,但您可自行編輯。此名稱不得在任何其他webhook中重複。 |
| 目的地 URL | FedEx將透過此安全HTTPS端點,傳送查詢事件數據。 要求:
|
| 安全令牌 | 用於透過HMAC進行身份驗證及驗證webhook回應的共用密碼。 要求:
|
| 數據語言 (國家/地區) | 從下拉清單選擇查詢數據翻譯的偏好語言。 |
| 查詢類型 | 選擇查詢數據的交付方式:
|
| 電郵地址 | 提供有效的電郵地址,以接收通知。 |
| 電郵語言(國家/地區) | 選擇電郵通知的偏好語言。 請注意:僅支援美國地區(例如en-US、es-US)。 |
逐步流程
4. 建立訂閱項目
- 按照上一部分的步驟操作,或者參閱《入門指南》。
5. 生成OAuth令牌
- 您需要OAuth令牌,才能發起API呼叫。
- 使用「授權API」以生成令牌。
- 如需詳細步驟,請參閱API目錄中的「授權API說明文件」。
6. 存取API說明文件
- 在左側導覽選單中,點擊「項目詳情」。
- 在「正式版金鑰」索引標籤中,捲動以尋找「進階集成可見性查詢號碼訂閱API」說明文件。
API端點概覽
| 端點 | 用途 |
|---|---|
| 查詢號碼關聯 | 在webhook訂閱中新增或移除查詢號碼。這是一項非同步作業。回應中會發回「作業ID」。 |
| 查詢號碼作業詳情 | 提供特定作業ID的詳情,例如已成功新增或仍在處理中的查詢號碼數量。 |
| 查詢號碼作業狀態 | 發回目前正在處理之所有作業的摘要。 |
使用第2步產生的OAuth令牌和「查詢號碼關聯」端點,將查詢號碼新增至您的webhook。
驗證規則
- Webhook名稱必須為唯一。
- 目的地網址必須遵循標準句法格式。
- 必須填寫所有必填欄位。
- 至少必須有一個有效的FedEx託運帳號相關聯。
驗證結果
| 狀態 | 詳細資料 |
|---|---|
| 成功 | 畫面上將會顯示確認訊息: 「<>已成功建立。變更最長可能需要10分鐘才能生效。」 |
| 不成功 | 若FedEx收到200(確定)或202(已接受)以外的回應,webhook目的地網址驗證將視為失敗。 |
Response