開始使用
與 FedEx 整合後,您便可開始運用 FedEx 應用程式開發介面 (API) 和 Webhook 帶來的各種優勢。下列指示會引導您進行每一個步驟:設定組織、建立專案,或以相容的使用者身分開始整個流程。
步驟 1︰
瀏覽應用程式開發介面 (API) 與 Webhook
您可以先瀏覽我們的應用程式開發介面 (API) 和 Webhook,以確定您的需求以及找出適合您應用程式的最佳解決方案。
- 前往應用程式開發介面 (API) 目錄即可開始瀏覽。
- 選取一項應用程式開發介面 (API) 或 Webhook 以閱讀總覽、探索變更記錄檔以及檢閱關鍵功能。
![託運應用程式開發介面 (API) 頁面的螢幕擷取畫面](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/1_My_Projects_Table%202.png)
- 檢閱文件,以深入瞭解關於請求與回應元素、所選程式設計語言的範例、錯誤代碼以及其他資訊。
![建立貨件頁面的螢幕擷取畫面](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/2_Screenshot%202023-08-15%20at%2011.08%201.png)
- 查看公告頁面以瞭解預計的服務更新並取得最新消息。
步驟 2︰
註冊或登入
使用您的 fedex.com 用戶識別碼與密碼登入,開始與 FedEx 應用程式開發介面 (API) 和 Webhook 進行整合。
如果您還沒有用戶識別碼,可以免費註冊。
步驟 3︰
建立或加入一個組織。
如果您的公司還沒有組織,請建立一個;或加入公司現有的組織。
若要建立組織:
如果組織是由您所建立,系統會自動將您列為該組織的管理員。
- 管理員可以邀請使用者加入其組織、為其指定角色 (例如,貢獻者或檢視者) 和專案,以及管理託運帳戶。
- 若要深入瞭解這些角色,請探索我們的組織管理指南。
若要建立自己的組織,請按一下左側導覽列中的建立組織。
提供組織資訊
- 提供公司名稱、網站 URL 並建立組織名稱。為組織命名一個其他使用者可以識別的名稱,此名稱可將貴公司組織為更具體的團體 (例如,部門、處、地區、地點),也可以與貴公司的名稱相同。
![「建立組織」頁面的螢幕截圖](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/3_screencapture-tank-fxfdp-v123-tankstaging-organizations-create-2023-05-12-14_52_01%201.png)
若要加入組織:
您可以完成下列步驟來加入現有的組織:
- 要求貴組織的管理員傳送邀請給您
- 如果貴公司已建立組織,請要求該組織的管理員邀請您加入。請在 24 小時內接受邀請;如果錯過此時限,您可以請管理員重新傳送邀請給您。
- 接受邀請
- 若要接受邀請,您需要使用現有的用戶識別碼與密碼登入;或者,如果您現有的用戶識別碼已與某個組織建立關聯,則需要建立一個新的用戶識別碼。
步驟 4︰
新增一個託運帳戶。
- 完整填寫帳戶資訊
- 輸入您的帳號、帳戶暱稱以及與帳戶相關聯的帳單地址。接著我們會驗證該帳單地址,確認其與帳戶詳細資料相符,以防範詐騙活動。
- 若要檢視與您的用戶識別碼相關聯的託運帳戶,請前往管理組織頁面,然後按一下託運帳戶索引標籤。若要建立新託運帳戶,請聯絡您的 FedEx 業務代表。
![「新增寄件帳戶」頁面的螢幕截圖](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/4_screencapture-tank-fxfdp-v123-tankstaging-accounts-create-2023-05-12-14_54_19%201.png)
- 使用者授權合約
- 您必須接受使用者授權合約 (EULA)或將其傳送給使用者公司內部的其他個人,且對方必須可接受該合約。您可以在「管理組織」頁面的託運帳戶索引標籤中,檢視使用者授權合約的狀態。
![「執行使用者授權合約」頁面的螢幕截圖](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/5_screencapture-tank-fxfdp-v123-tankstaging-accounts-create-2023-05-12-14_55_10%201.png)
步驟 5︰
將使用者新增至您的組織
管理員可以邀請用戶加入其組織,並為其指定角色與專案。若要開始,您可以完成下列步驟 (以 * 標示者為選擇性項目) 以在「管理組織」頁面新增使用者:
輸入使用者電子郵件地址
- 輸入任何使用者的電子郵件地址以邀請他們加入您的組織。您可以在地址間按下鍵盤上的空格、逗點、分號或 Enter 鍵來輸入多個電子郵件地址
選取使用者角色
- 若「檢視者」的預設選項不符合該使用者的需求,請選擇其他的使用者角色。*
將使用者指派至專案
- 若您已經建立專案,可以將使用者至某指派個專案。*
![「新增使用者」頁面的螢幕截圖](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/6_Manage_Org_Add_User_Modal_Default%201.png)
管理員將一律具有所有專案的存取權,但貢獻者或檢視者必須指派至某個專案 (除非貢獻者建立了專案,在此情況下,貢獻者會自動指派至該專案)。
無論使用者是否接受邀請,您都可以直接在管理組織頁面的使用者索引標籤中快速更新其專案或角色。
- 按一下角色或專案旁的插入符號,便會顯示內含選項的下拉清單
- 選取選項,然後選取套用按鈕以儲存選取項目。
![「管理組織」頁面的螢幕截圖](/api/content/dam/fedex-com/irc/getting-started-oct/create-org/7_screencapture-tank-fxfdp-v123-tankstaging-organizations-2023-05-12-14_56_30%201.png)
步驟 1:
建立一項專案以取得認證。
貴組織的管理員或貢獻者可按一下建立應用程式開發介面 (API) 專案按鈕,以建立應用程式開發介面 (API) 專案。
開始之前,您必須先告知我們,為何您需要存取 FedEx 應用程式開發介面 (API)。畫面會顯示強制回應視窗,並提供您下拉清單選項。您應選取最適切的選項,說明您與 FedEx 應用程式開發介面 (API) 整合的業務需求。
若您表明自己為寄件人,便可開始建立專案。程序共有三個步驟:
- 選取應用程式開發介面 (API)
選取您想要包含在專案中的應用程式開發介面 (API)。根據您選取的應用程式開發介面 (API),您可能需要額外選取其他選項。
若您選取查詢應用程式開發介面 (API),您也必須:
- 選取帳號以便與您的生產金鑰建立關聯。
- 檢閱查詢應用程式開發介面 (API) 額度、費率限制,以及應用程式開發介面 (API) 認證詳細資料。
- 選擇您是否要接收電子郵件,以便收到是否超過交易額度的通知。
![建立應用程式開發介面 (API) 專案](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/1_Image.png)
- 設定專案
輸入專案具體資訊,包括名稱和託運地點。
- 為專案設定一個貴組織專屬的識別名稱
- 選取您計畫在其境內進行託運的任何國家/地區,以便我們為您指派測試託運帳戶。若要在歐洲國家/地區的國內測試託運包裹,您必須對每個國家/地區建立個別的測試帳戶。日後您可以隨時新增或移除國家/地區。
- 若要接收有關最新應用程式開發介面 (API) 消息的通知以及任何服務中斷相關資訊,您可以設定通知偏好設定。
![step2](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/2_Image-1.png)
- 確認詳細資料
請檢閱您的專案詳細資料,然後接受條款與細則。
- 閱讀並接受 FedEx Developer Portal 授權合約,並確認您無意銷售或發佈您的應用程式。
- 按一下「建立」按鈕後,確認畫面隨即顯示。接著,您可以在新專案中檢視您的測試認證。
![step3](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/3_Image-2.png)
步驟 2︰
整合應用程式開發介面 (API) 並測試實作
帳戶)。接著,您可以:
- 要求一個必須與每筆應用程式開發介面 (API) 交易一起使用的 OAuth 存取權杖。此權杖的有效時間只有一小時,因此您必須將應用程式的程式碼設計為可於工作階段逾期之前重新整理權杖。如需更多詳細資料,請參閱應用程式開發介面 (API) 授權文件
- 按一下應用程式開發介面 (API) 的任一文件,即可閱讀每個應用程式開發介面 (API) 的業務內容,以便充分瞭解如何使用該應用程式開發介面 (API)。您也可以檢閱與您所需整合相符的端點範例要求。
- 依範例要求中所述,對這些端點實作您的呼叫,使用您的測試認證來設定這些端點。
- 確認您收到的應用程式開發介面 (API) 呼叫回應與文件中所顯示的相符。
- 使用您的測試認證與 FedEx 測試 URL,在 FedEx 測試環境中測試您的實作。
![API project overview](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/4_Image-3.png)
步驟 3︰
將專案移至生產階段
將專案移至生產階段。
在設定專案步驟中:
- 您可視需要為金鑰重新命名。
- 檢閱您在專案建立流程步驟 1 中選取的帳號。這可用來將您的專案移至生產階段。您的專案在生產階段上線後,您便可視需要新增更多帳戶。
![production key tab](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/5_Image-4.png)
在取得專案金鑰步驟中:
- 畫面會顯示您的生產應用程式開發介面 (API) 金鑰及產生祕密金鑰。請務必將其複製至安全處所妥善保存。
- 為了確保產生祕密金鑰的安全,我們只會顯示一次。如果您不慎遺失,可以產生新的祕密金鑰。
- 按一下「下一步」。
![production key step2](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/6_Image-5.png)
您現在會回到專案總覽頁面。您可以在這裡新增更多與專案相關聯的帳戶。
在專案總覽頁面中:
- 按一下垂直的 3 個點 (或選單圖示) 以新增更多與專案相關聯的帳戶。
- 接著,按一下編輯。
這會將您導向應用程式開發介面 (API) 金鑰頁面,您可以在其中新增任何額外帳戶,以便與此專案的生產金鑰建立關聯。
![API project overview after steps](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/7_Image-6.png)
步驟 4︰
完成認證
- 某些應用程式開發介面 (API) 需要有託運標籤認證,才能在我們的生產環境中使用。為滿足此要求,您需要完成專案中所有應用程式開發介面 (API) 的認證程序。
![API Certification](/api/content/dam/fedex-com/irc/getting-started-oct/create-project/8_screencapture-tank-fxfdp-v123-tankstaging-api-certification-2023-05-12-15_05_33%201.png)
所有的應用程式開發介面 (API) 均經過認證並啟用之後,請將測試 URI、金鑰及託運帳戶替換為生產 URI、金鑰及託運帳戶,藉此更新您的應用程式開發介面 (API) 要求。
在生成環境中使用範本資料重新測試您的實作。
享受全新整合為您帶來的效益!
建立 Webhook 專案的先決條件
建立 Webhook 專案
建立 Webhook 專案的先決條件
步驟 1︰
在您的目的地應用程式/平台中建立有效的 URL
請在目的地應用程式/平台中建立有效的 URL,以接收來自 FedEx 的驗證代碼/訊息以及 Tracking Webhook 承載通知。
URL 要求:
- 包含 RFC1918 IP 空間
- 包含 fedex.com 或其任何子網域
- URL 中包含 IP 位址 (包括本機主機,127.0.0.1)
步驟 2︰
產生安全性權杖
此安全性權杖可用作祕密金鑰以驗證您 (即客戶) 與 FedEx 之間傳輸的資訊。
安全性權杖要求:
- 長度至少為 25 個字元,最多 100 個字元
- 1 個大寫字母字元
- 1 個小寫字母字元
- 1 個數字字元
步驟 3︰
測試 Webhook URL
測試 URL 為選用步驟,將會對您有所助益。
測試可協助您更加瞭解您在步驟 1 中建立的 URL 是否有效。這可讓 FedEx 識別您的 URL 並與此 URL 建立連線以傳送資料。測試也可提供您樣本測試資料,有助於檢查並確認您是否能處理應用程式中提供的查詢資料。不過,測試不會驗證您的 URL。
請瀏覽我們的 Webhook 文件以瞭解如何測試您的 Webhook URL。
步驟 4︰
驗證目的地 URL
使用 HMAC SHA256 雜湊演算法設定驗證程序,以驗證您的目的地 URL 與 FedEx 之間傳輸的資訊。
![screenshot of Validate destination URL](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/1.%20Webhook-Infographic.png)
- 按一下建立後,FedEx 隨即產生隨機安全字串,這會顯示在您收到的請求內文中。接著,您必須在回應內文中將此安全字串傳回至 FedEx。
- 使用 HMAC SHA256 演算法/程序初始化訊息驗證碼 (MAC),將安全字串和安全性權杖 (或祕密金鑰) 雜湊化 (或合併) 以形成雜湊簽章
- 在回應內文中以 challengeString 和 challengeStringResponse,連同 HTTP 狀態碼 200 (OK) 或 202 (ACCEPTED),回應 FedEx
- FedEx 將會驗證 challenge string 和 challenge string response。
- FedEx 收到回應內文後,FedEx 會驗證 challengeString 和 challengeStringResponse (或先前產生的雜湊簽章),方法是分別比對 FedEx 產生的 challengeString 和雜湊簽章。
- 若「challengeString」和 HMAC 簽章均相符,則驗證和工作流程成功。否則,驗證程序會失敗,且畫面會顯示對應的錯誤訊息。
建立 Webhook 專案
步驟 1︰
建立 Webhook 專案以接收設定的承載通知
在我的專案頁面中,前往 Webhook 索引標籤。
貴組織的管理員或貢獻者可按一下建立 Webhook 專案按鈕,以建立 Webhook 專案。
開始之前,您必須先告知我們,為何您需要存取 FedEx Webhook。畫面會顯示強制回應視窗,並提供您下拉清單選項。您應選取最適切的選項,說明您與 FedEx Webhook 整合的業務需求。
若您表明自己為寄件人,便可開始建立專案,方法是完成下列步驟:
![screenshot of create a webhook page](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/2.%20My%20Webhooks_Projects.png)
- 找出您的業務需求
- 選取最適切的選項,以說明為何貴企業想要與 FedEx Webhook 整合。
![identify your business needs](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/3.%20Self_Identification_Modal.png)
- 選取層級和層級功能
- 根據您的專案需求,為專案選取基本或進階 Webhook 層。
- 日後您隨時可以編輯選擇的層級。
- 每個層級均設有月費訂閱機制。
![tire and tire features](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/4.%20Tier_Selection.png)
- 選取您要藉由專案設定的功能。
- 您也可以在稍後編輯功能。
![feature selection](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/5.%20Features_Selection.png)
- 設定專案詳細資料
- 為您的專案設定可辨識的名稱
- 提供預先產生的目的地 URL 和安全性權杖詳細資料,這些是在預先設定驗證期間建立的。
資料欄名稱 | 說明 |
---|---|
Webhook 專案名稱 目的地 URL |
此唯一的 Webhook 專案名稱不得為空白,且不得於任何其他 Webhook 專案中重複使用。
此為您接收查詢事件資料/承載的 URL。
|
安全性權杖 |
這可當作共用密碼來驗證 Tracking Webhook 回應。
|
承載語言 (國家/地區) 查詢類型 |
請從下拉清單中選取查詢資料翻譯的慣用語言。 請選取須接收查詢資料之回應的類型
|
電子郵件地址 |
請提供電子郵件地址,以便在 Webhook 專案變更時 (例如,已建立、已編輯、已取消) 接收電子郵件通知。 |
電子郵件語言 (國家/地區) |
請選取要接收來自 FedEx 之 Webhook 電子郵件通知的慣用語言 電子郵件通知支援的語言如下:
|
![create webhook step2](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/6.%20Create%20Webhook_Step%202_Enter_Details.png)
- 選擇帳戶
- 從合格 (美國或加拿大地區) 帳號清單中選擇您要與專案建立關聯的帳號。
5. 確認詳細資料並接受條款
- 檢閱已設定專案的詳細資料。
- 閱讀並接受 Developer Portal 授權合約,並確認您無意發佈您的應用程式。
- 閱讀並接受定價合約。
- 按一下建立專案按鈕後:
- 若您建立的請求已順利經驗證和處理完成,系統會將您導向確認畫面。
- 若驗證失敗,畫面會顯示錯誤訊息。
- 您的 Tracking Webhook 專案接著會有系統產生的 Webhook ID 並顯示狀態為「有效」。
![terms](/api/content/dam/fedex-com/irc/getting-started-oct/create-webhook-project/7.%20Create%20Webhook_Step%204_Confirm_Details.png)
步驟 1:
FedEx 會建立相容供應商組織
- FedEx 會建立組織,接著邀請一名團隊成員加入組織。FedEx 會指派該使用者擔任組織的管理員。
- 完成認證與整合後,您就能輕鬆配送解決方案給客戶。
步驟 2︰
接受邀請。
- 若要存取應用程式開發介面 (API) 整合品項與文件,請接受邀請。若要接受邀請,您需使用 FedEx 用戶識別碼與密碼登入;如果您仍未擁有認證,請建立新的認證。
步驟 3︰
邀請使用者加入您的組織。
- 成為管理員後,您就能邀請任何需要存取專案或組織的團隊成員加入。如需不同角色的詳細資料,請參閱組織管理指南。
![Manage org](/api/content/dam/fedex-com/irc/getting-started/step-3-invite-users@2x.png)
- 如果您的組織已建立完成,請要求組織管理員或 FedEx 邀請您加入。請在 24 小時內接受邀請;如果錯過此時限,您可以請管理員重新傳送邀請給您。
步驟 4︰
選取解決方案所需的應用程式開發介面 (API)。
請瀏覽應用程式開發介面 (API) 目錄,確定您的解決方案適合哪個應用程式開發介面 (API)。FedEx 客戶技術顧問 (CTC) 和兼容管道管理員可依照您的業務需求,協助您選取適合您解決方案的應用程式開發介面 (API)。
![API Catalog](/api/content/dam/fedex-com/irc/getting-started/step-4a-select-apis@2x.png)
選取應用程式開發介面 (API),以探索總覽畫面、變更記錄及重要功能。
![Address validation API](/api/content/dam/fedex-com/irc/getting-started/step-4b-select-apis@2x.png)
檢視應用程式開發介面 (API) 文件,以瞭解請求與回應元素、您所選語言的範例,以及錯誤物件等項目。
![Address validation API-intro](/api/content/dam/fedex-com/irc/getting-started/step-4c-select-apis@2x.png)
返回 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) 整合至您的應用程式,並完成 兼容 計畫認證作業。
- 目前您已可以存取測試應用程式開發介面 (API) 金鑰和測試秘密金鑰,開始執行交易項目。您可以前往「專案總覽」頁面的「測試金鑰」索引標籤,擷取這些金鑰。
- 若要建立客戶金鑰,您需使用認證註冊應用程式開發介面 (API),這種個人專用的 API 僅會顯示於各專案的 API 區段。
- 建立數個客戶金鑰後,請接著索取 OAuth 存取權杖,以供各應用程式開發介面 (API) 交易使用。權杖工作階段的有效時間只有一小時,因此您必須設計應用程式的程式碼,使其可在工作階段逾期前重新整理權杖。如需詳細資訊,請參閱應用程式開發介面 (API) 授權文件。檢視範例程式碼時,請務必從範例下拉清單選擇「經銷商」。
![API Authorization](/api/content/dam/fedex-com/irc/getting-started/step-6b-integrate@2x.png)
- 在「測試金鑰」頁面中選取 API 文件,並詳閱業務內容,充分瞭解如何使用選取的 API。檢閱與您所需整合相符的端點範例要求。
- 依範例要求中所述,對這些端點實作您的要求,將它們設定為使用您的測試認證。
- 確認收到的 API 要求回應與文件中所顯示的相符。
- 使用測試認證與 FedEx 測試 URI,在 FedEx 測試環境中完整測試您的實作。
- 完整測試解決方案後,請認證 Salesforce 中的每個解決方案。FedEx 會完整審核您提交的所有解決方案,並在您的認證通過核准後通知您。
步驟 7:
FedEx 會將專案移入生成程序。
- 接著,FedEx 會將專案移入生成程序。
- 之後,您就能在「專案總覽」頁面的「正式版金鑰」索引標籤下,檢視正式版 API 金鑰。
步驟 8:
產生生產程序專用的秘密金鑰。
- 您必須按一下祕密金鑰欄下方的產生祕密金鑰連結,系統才會為您產生「生產祕密金鑰」。
- 現在您可以使用範例資料,在生成環境中重新測試實作項目了。
- 享受全新整合為您帶來的效益!