使用入門
當您與 FedEx 整合後，便可以充分善用 FedEx API 及 Webhook 帶來的價值優勢。這些指示將引導您完成設定組織、建立項目，以及以兼容用戶身份開始的整個流程。
步驟 1：
瀏覽 API 和 Webhook
開始時您可以瀏覽我們的 API 和 Webhook，以判斷您的需要並找出最適合您的應用程式的最佳解決方案。
- 前往 API 目錄開始瀏覽。
- 選擇一個 API 或 Webhook 便可閱讀概覽、探索更新記錄，以及查看主要功能。
- 查閱文件詳細了解各要求和回覆的內容、您所選編程語言的示例、錯誤代碼及其他資訊。
- 請查閱公布頁面，了解預設服務更新及最新消息。
步驟 2：
註冊或登入
使用您的 fedex.com 用戶 ID 及密碼登入，開始整合 FedEx API 和 Webhook。
如果您尚未擁有用戶 ID，可以免費登記。
步驟 3：
建立或加入組織。
加入您公司現有的組織，如您的公司尚未建立組織，請建立一個組織。
建立組織：
如果您建立組織，將自動成為該組織的管理員。
- 管理員可以邀請用戶加入組織，指派用戶身份（例如：研發員或審閱員）及項目，並可以管理託運帳戶。
- 如要了解各個身份的更多資訊，請參閱我們的《組織管理指南》。
如要建立您自己的組織，請點擊左側導覽欄的建立組織。
提供組織資料
- 提供您的公司名稱、網站網址，並建立組織名稱。為您的組織命名，以供其他用戶識別。此名稱可用於將貴公司整理至更具體的組別（例如：部門、分部、地區、地點），也可以與您的公司名稱相同。
加入組織：
您可以完成下列步驟，以便加入現有的組織：
- 要求貴組織的管理員向您發送邀請
- 如貴公司已建立組織，請要求組織管理員邀請您加入。邀請有效時間為 24 小時。如果您未能在此時段內接受邀請，您可以請求管理員再次發出邀請。
- 接受邀請
- 如要接受邀請，您需要憑您現有的用戶 ID 及密碼登入，如您現有的用戶 ID 已經聯繫另一個組織，則需要建立新用戶 ID。
步驟 4：
新增託運帳戶。
- 填寫帳戶資料
- 輸入您的帳號、帳戶暱稱，以及與帳戶聯繫的帳單地址。我們將驗證帳單地址，以確保與帳戶詳細資訊相符，防止欺詐行為。
- 如要檢視與您用戶 ID 聯繫的託運帳戶，請前往管理組織頁面，並前往託運帳戶索引標籤。如要建立新的託運帳戶，請聯絡您的 FedEx 營業代表。
- 最終使用者授權合約
- 您必須接受《最終使用者授權合約》 (EULA)，或發送給終端用戶公司內有權接受該合約的其他人。您可於「管理組織」頁面的託運帳戶索引標籤中查看 EULA 狀態。
步驟 5：
新增用戶至您的組織
管理員可邀請用戶加入他們的組織，並為用戶指派身份及項目。如要開始，您可於「管理組織」頁面完成下列步驟以新增用戶(標有星號的為可選項目)：
輸入用戶電郵地址
- 輸入您希望邀請加入貴組織之任何用戶的電郵地址。您可以按鍵盤上的空格、逗號、分號或輸入鍵，作為電郵地址之間的分隔，便可輸入多個電郵地址。
選擇用戶身份
- 如預設的審閱員選項並不適合該用戶的需求，請選擇其他用戶身份。*
為用戶分配項目
- 如您已建立項目，可以把項目分配給用戶。*
管理員永遠都能存取所有項目，但研發員或審閱員則必須先獲指派項目 (除非該項目由研發員建立；在此情況下，研發員會自動獲指派至該項目)。
無論用戶接受邀請與否，您都可以在管理組織頁面的用戶索引標籤下，快速更新他們的項目或身份。
- 點擊身份或項目旁的插入符號，隨即出現提供各種選項的下拉清單
- 選擇一個選項，然後選擇套用按鈕以儲存選擇。
步驟 1：
建立項目，以取得憑證。
您的組織的管理員或研發員，可以點擊建立 API 項目按鈕便可建立 API 項目。
開始之前，您需要先告訴我們，您需要存取 FedEx API 的原因。系統會顯示訊息，並向您展示下拉清單選項。請選擇最符合您整合 FedEx API 之業務需求的選項。
如果您是寄件人，便可以開始建立項目。此過程分為三個步驟：
- 選擇 API
選擇您希望加入項目中的 API。依照所選擇的 API，您可能需要額外選項。
如果您選擇貨件查詢 API，您亦需要：
- 選擇與正式版金鑰連繫的帳號。
- 檢查貨件查詢 API 配額、速度限制及 API 認證詳細資訊。
- 選擇您是否希望訂閱電郵，以在超出交易配額時接收通知。
- 設定項目
輸入項目的部分具體資料，包括名稱和託運地點。
- 為項目命名，名稱應容易辨識，並且是組織內獨一無二的名稱。
- 選擇您打算在其境內託運的任何國家／地區，以便我們為您分配測試託運帳戶。如要測試歐洲國家／地區的本地包裹託運，您必須就每一個國家擁有一個獨立測試帳戶。您稍後可以隨時新增／移除國家／地區。
- 如要取得有關最新 API 更新的通知，以及任何與服務中斷相關的資訊，您可以設定通知偏好。
- 確認詳情
核對您的項目詳情，才可接受條款及細則。
- 請細閱並接受《FedEx Developer Portal 授權合約》，並確認您不擬出售或分銷您的應用程式。
- 按下「建立」按鈕後，您將看到確認畫面。此時您可以在新項目中檢視測試憑證。
步驟 2：
整合 API 並測試實際操作
帳戶 — 檢索位置在測試金鑰索引標籤下方。接著您可以：
- 要求 OAuth 存取令牌，每一項 API 交易均須使用該令牌。令牌僅有效 1 小時，因此您須在應用程式內設定編碼，以便在失效前重新整理令牌。請參閱《API 授權文件》了解詳細資訊。
- 點擊 API 的任何文件，細閱每個 API 的業務背景，深入了解其用法。您亦可以檢視與所需整合相符的端點請求示例。
- 請按照要求示例所述執行您的終端指示，使用您的測試憑證進行設定。
- 驗證您收到的 API 執行指示的回覆與文件中所述相符。
- 在 FedEx 測試環境中使用您的測試憑證和 FedEx 測試網址，測試您的實際操作。
步驟 3：
將您的項目轉換為正式版
完成下列步驟，開始將項目轉換為正式版。
在設定項目步驟中：
- 您可以按需要重新命名金鑰。
- 查看您在項目經理流程第 1 步所選擇的帳號。這用於將您的項目轉換為正式版。當您的項目轉換為正式版後，您可以按需要新增更多帳戶。
在取得項目金鑰步驟中：
- 系統會顯示您的正式版 API 金鑰及正式版秘密金鑰。請確保您已複製並在安全地方儲存這些金鑰。
- 為保障您的正式版秘密金鑰安全，我們僅會顯示該金鑰一次。如果您遺失金鑰，便需要產生新的金鑰。
- 按一下下一步。
現在系統會將您帶回項目概覽頁面。您可於此處新增更多與項目連繫的帳戶。
在項目概覽頁面上：
- 點擊垂直 3 點圖示 (直排三點功能表)，新增更多與項目連繫的帳戶。
- 接著，點擊編輯。
此操作會將您帶至 API 金鑰頁面，您可於該頁面上新增想與此項目之正式版金鑰連繫的額外帳戶。
步驟 4：
完成認證
- 部分 API 需要有託運標籤認證，方可在我們的正式版環境中使用。請完成項目中所有需要此認證的 API 之認證程序。
所有 API 已獲認證及啟用後，請將測試網址、金鑰及託運帳戶替換為正式版網址、金鑰及託運帳戶，以更新您的 API 請求。
請使用示例數據在正式版環境中重新測試實際操作。
享受全新整合工作所帶來的好處吧！
建立 Webhook 項目的先決條件
建立 Webhook 項目
建立 Webhook 項目的先決條件
步驟 1：
在目的地應用程式／平台建立有效的網址
在目的地應用程式／平台中建立有效的網址，以接收 FedEx 的授權驗證碼／訊息和查詢 Webhook 數據通知。
網址要求：
- 包含 RFC1918 IP 空間
- 包含 fedex.com 或其任何子網域
- 網址中包含 IP 位址 (包括本機主機，127.0.0.1)
步驟 2：
產生安全令牌
此安全令牌可用作秘密金鑰，以授權及驗證您 (顧客) 與 FedEx 之間傳輸的資料。
安全令牌要求：
- 必須至少有 25 個字元，最多為 100 個字元
- 1 個大寫字母
- 1 個小寫字母
- 1 個數目字
步驟 3：
測試 Webhook 網址
測試網址為可選步驟，或能為您提供幫助。
測試有助您清晰了解您在第 1 步中建立的網址是否有效。測試亦能讓 FedEx 識別您的網址，並與您的網址建立連接以傳送數據。測試亦能為您提供樣本測試數據，協助您檢查並確認自己能否處理應用程式中提供的查詢數據。然而，測試無法授權驗證您的網址。
請瀏覽我們的 Webhook 文件，了解如何測試您的 Webhook 網址。
步驟 4：
驗證目的地網址
使用 HMAC SHA256 雜湊演算法，設定授權驗證流程，以驗證目的地網址與 FedEx 之間傳輸的資料。
- 點擊建立後，FedEx 將產生隨機安全驗證字串，並透過請求正文發送給您。您需要透過回應正文將該安全驗證字串發回給 FedEx。
- 使用 HMAC SHA256 演算法／程序來雜湊（或結合）安全驗證字串及安全令牌（或秘密金鑰）組成雜湊簽名，從而將訊息授權驗證碼 (MAC) 初始化
- 透過回應正文向 FedEx 發回安全驗證字串及安全驗證字串回應，以及 HTTP 狀態碼 200 (OK) 或 202 (ACCEPTED)。
- 此時，FedEx 便會驗證安全驗證字串及安全驗證字串回應。
- FedEx 收到回應正文後，將比對 FedEx 所產生的安全驗證字串和雜湊簽名，以驗證安全驗證字串及安全驗證字串回應 (或較早前產生的雜湊簽名)。
- 如果「安全驗證字串」與 HMAC 簽名相符，則驗證和工作流程成功。否則即視為驗證流程失敗，系統將顯示對應的錯誤訊息。
建立 Webhook 項目
步驟 1：
建立 Webhook 項目接收已設置的數據通知
在我的項目頁面上，前往 Webhook 索引標籤。
貴組織的管理員或研發員，可以點擊建立 Webhook 項目按鈕，以建立 Webhook 項目。
開始之前，您需要先告訴我們，您為何需要存取 FedEx Webhook。系統會顯示訊息，並向您展示下拉清單選項。請選擇最符合您整合 FedEx Webhook 之業務需求的選項。
如果您是寄件人，便可以完成下列步驟，開始建立項目：
- 辨別您的業務需求
- 選擇最符合您的業務希望整合 FedEx Webhook 之原因的選項。
- 選擇級別及級別功能
- 基於項目需要，為您的項目選擇基本版或進階版 Webhook 級別。
- 您可以稍後隨時編輯級別選擇。
- 每個級別都設有訂閱月費。
- 選擇您希望設定至項目中的功能。
- 您亦可以稍後編輯功能。
- 設定項目詳細資訊
- 為項目命名；名稱必須容易辨識
- 提供預先產生的目的地網址和安全令牌詳細資訊；這些資訊已在設定前的授權驗證期間建立。
| 欄位名稱 | 說明 |
|---|---|
Webhook 項目名稱 目的地網址 |
此乃非空白且獨立的 Webhook 項目名稱，不應在任何其他 Webhook 項目中重複使用。
這是您接收查詢事件資料／數據的網址。
|
安全令牌 |
這用作共用密碼，可以授權及驗證查詢 Webhook 回應。
|
數據語言 (國家／地區) 查詢類型 |
從下拉選單選取查詢數據翻譯的偏好語言。 選擇要接收查詢數據的回應類型
|
電郵地址 |
提供電郵地址以便您的 Webhook 項目有任何更改時接收電郵通知（例如：建立、編輯、取消） |
電郵語言（國家／地區） |
選擇您接收由 FedEx 傳送 Webhook 電郵通知時的偏好語言 電郵通知的支援語言如下：
|
- 選擇帳戶
- 從合資格（位於美國或加拿大）帳號列表，選擇您想與項目聯繫的帳號。
5. 確認詳情並接受條款
- 核對已設定的項目詳情。
- 請細閱並接受《Developer Portal 授權合約》，並確認您不擬分銷您的應用程式。
- 請細閱並接受《定價協議》。
- 當您點擊建立項目按鈕後：
- 如果您的建立要求成功通過驗證並完成處理，系統會將您帶至確認畫面。
- 如果未能通過或驗證失敗，則會顯示錯誤訊息。
- 隨後，您的查詢 Webhook 項目將獲授予由系統產生的 Webhook ID，並顯示狀態為「活躍」。
步驟 1：
FedEx 建立 Compatible 供應商組織
- FedEx 將建立組織並邀請一名團隊成員加入。該名用戶將被指定為您組織的管理員。
- 完成認證和整合工作後，您便能輕鬆將解決方案分配給您的客戶。
步驟 2：
接受邀請。
- 如要存取 API 整合工具和文件，請接受邀請。如要接受邀請，您需要憑 FedEx 用戶 ID 及密碼登入，如您並未有憑證，則需要建立新用戶 ID 及密碼。
步驟 3：
邀請用戶加入您的組織。
- 擔任管理員，您便可以邀請任何需要存取項目或組織的團隊成員。有關不同身份的詳細資料，請參閱組織管理指南。
- 如您的組織已建立，請讓組織管理員或 FedEx 邀請您加入。邀請有效時間為 24 小時，但如果您未能在此時段內接受邀請，您可以請求管理員再次發出邀請。
步驟 4：
選擇您的解決方案所需的 API。
瀏覽 API 目錄因應您的解決方案找出合適的 API。您的 FedEx 客戶技術顧問 (CTC) 和 Compatible Channel 經理可以根據您的業務需要，協助您選擇適合解決方案的 API。
選擇 API 以檢視概覽、修改記錄及主要功能。
瀏覽 API 文件詳細了解各要求和回覆的內容、您所選編程語言的示例、錯誤代碼及其他資訊。
返回 Salesforce 填寫產品資訊工作表 (PIW)，並列出您想新增至解決方案中的 API。
步驟 5：
FedEx 建立項目。
PIW 一經審核，FedEx 便會為您建立項目。您每個解決方案的每個版本，都會在 FedEx Developer Portal 內設有獨立的項目。若用戶並非組織管理員，便需要獲得邀請才能查看項目。
當 FedEx Compatible 團隊和 FedEx CTC 及認證團隊為您的團隊籌辦 API 技術示範時亦然。FedEx 團隊會討論您要採用之 API 版本的新特色和可用功能。團隊可以解答有關 API 的技術問題、進行 API 測試，以及處理開展 API「認證*」前必須完成的所有流程。
* 認證 – FedEx Compatible 計劃內列明符合計劃要求規定的流程。必須完成 Compatible 計劃認證，以確保所有 Compatible 供應商按照 FedEx 技術與服務標準指定向寄件人 (客戶) 安裝、推廣及發佈 FedEx 技術。
步驟 6：
將 API 整合至您的應用程式並取得 Compatible 計劃認證。
- 現在您可以存取測試 API 金鑰和測試秘密金鑰，開始測試交易操作。在項目概覽頁面的測試金鑰分頁檢索這些金鑰。
- 如要建立客戶金鑰，您需要使用憑證註冊 API，此私人 API 只可於您每個項目的 API 部分找到。
- 建立若干客戶金鑰後，請前往索取 OAuth 存取代號，用於每一次的 API 交易。代號僅有效 1 小時，因此您須在應用程式內設定編碼，以便在失效前重新整理代號。請參閱 API 授權文件了解詳情。檢視示例代碼時，確保示例下拉清單中選擇了「轉售商」。
- 請選擇測試金鑰頁面內的 API 文件，並細閱業務背景，以深入了解所選 API 的用法。請檢視與所需整合工作相符的終端要求示例。
- 請按照要求示例所述執行您的終端指示，設定使用您的測試憑證。
- 確認所收到的 API 執行指示的回覆與文件中所述相符。
- 在 FedEx 測試環境中使用測試憑證及 FedEx 測試網址，完整地測試實際操作。
- 完全測試過您的解決方案後，請在 Salesforce 中認證每個解決方案。FedEx 將全面審查一切提交內容，並在認證獲批後通知您。
步驟 7：
FedEx 將項目轉換為正式版。
- 然後，FedEx 會將您的項目轉換為正式版。
- 屆時您將可以在「項目概覽」頁面的正式版金鑰分頁下，查看您的正式版 API 金鑰。
步驟 8：
索取正式版秘密金鑰。
- 您需要點擊秘密金鑰欄位下方的產生秘密金鑰連結，以產生正式版秘密金鑰。
- 現在您可以使用示例數據，在正式版環境中重新測試實際操作。
- 享受全新整合工作所帶來的好處吧！
