概覽
透過「進階集成可見性webhook」,FedEx能夠將近乎實時的安全查詢事件數據推送至與一個或以上之FedEx帳號相關聯的貨件目的地網址。您可建立webhook項目,以透過FedEx Developer Portal存取此功能。
導覽路徑
您可透過下列其中一種方式,前往webhook建立頁面:
- 透過「我的項目」:左側導覽選單 → 「Webhook」索引標籤 → +建立Webhook項目
- 透過API目錄:
- 左側導覽選單 → API目錄
- 搜尋或篩選「進階集成可見性」
- 概覽 → 點擊「說明文件」→ 在「沙盒控制台」中,點擊「+建立項目」
- 文件 → 點擊+建立Webhook
Webhook建立步驟
第1步:選擇公司類型
點擊「+建立項目」,然後從下拉清單中選擇您的公司類型:
- 選用FedEx託運服務,並需要將FedEx webhook整合至公司系統中。
- 出售或提供使用FedEx數據的軟件解決方案,但公司不是獲認證的FedEx Compatible供應商。
- 是獲認證的FedEx Compatible供應商。
請注意:此選項目前不適用於FedEx「進階集成可見性webhook」解決方案。如果您是FedEx Compatible計劃的成員,並需存取「基礎集成可見性」或其他FedEx整合解決方案,請聯絡您的渠道經理。如果您不知道渠道經理是誰,請聯絡您的公司管理員。
然後選擇「進階集成可見性帳號訂閱」作為您的訂閱類型。
建立「進階集成可見性帳號訂閱」
建立流程共有四個主要步驟:
第1步:啟用「進階集成可見性帳號訂閱」
此步驟由FedEx管理員或FedEx代表應第三方顧客的要求管理。
- MNDA文件:FedEx管理員或FedEx代表將取得《共同保密協議 (MNDA)》以及第1方/寄件人帳號的批量清單。
請注意:在此上載過程中,允許使用與其他組織相關聯的重複帳號。
- 在適用情況下,自訂價格將在組織層級啟用。
請注意:「7月份體驗」不包括此功能。
第2步:+建立項目
在「選擇產品」頁面上:
- 點擊「進階集成可見性」– 帳號,然後點擊「下一步」。
- 選擇付款帳戶,接受付款條款,然後點擊「下一步」。
必須至少新增一個付款帳戶。
在「確認詳情」頁面上:
- 檢閱項目資料。
- 接受《條款及細則》。
- 如「自訂價格」適用,畫面上將會自動顯示相關文件。
建立成功後,畫面上將會顯示確認訊息:
「您已成功新增產品至『我的項目』。」
步驟3:項目概覽 – API金鑰啟用流程
- 在「項目概覽」頁面的「API」部分的「API金鑰」索引標籤下,訂閱的正式版狀態最初將顯示為「已停用」。
- FedEx管理員或代表將應要求啟用產品。
- 啟用後,您將可存取正式版金鑰索引標籤,正式版狀態也會更新為「正在等待確認」。
- 由FedEx管理員或代表最終啟用後,正式版狀態將會顯示為「已啟用」。
第4步:項目概覽 – 配置webhook
- 導覽至「項目概覽」頁面。
- 選擇「Webhook」索引標籤。
- 點擊「+配置webhook」按鈕,開始配置webhook。您將被重新導向至「Webhook」索引標籤。
功能說明
| 欄位名稱 | 說明 |
|---|---|
| 送達證明 | 確認貨件已成功送達。包括: 送達證明圖像 (PPODA):提供顯示實際遞送地點的相片。 簽收證明 (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個帳戶,請使用webhooks API。
請聯絡FedEx顧客服務部或幫助櫃檯,以申請API存取權限。
第4步:確認詳情並建立
在「確認詳情」頁面上:
1. 檢閱您為webhook項目輸入的所有資料。
2. 剔選方格以接受條款及細則。
3. 點擊「建立」以完成webhook設置。
成功提交後,webhook將透過系統生成的訂閱ID來建立,並將設為「啟用中」狀態。
驗證規則
一般要求:
Webhook名稱必須為唯一。
目的地網址必須遵循標準化句法格式(安全的HTTPS,不得使用fedex.com或其子網域)。
所有必填欄位均必須填寫 — 不得留空任何必填欄位。
至少必須有一個有效的FedEx託運帳號與webhook相關聯。
驗證成功:
成功建立webhook後,顧客將會收到一則確認訊息:
<<Webhook名稱>>已成功建立。變更最長可能需要10分鐘才能生效。
驗證不成功/失敗:
若FedEx從目的地網址收到HTTP 200(確定)或202(已接受)以外的任何回應,webhook驗證將視為失敗。
Response