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