開始使用
充分運用 FedEx API 帶來的各種優勢,開始您的整合工作。以下指示將引導您完成設置組織、建立項目,以及以兼容使用者身份開始整個流程。
步驟 1:
瀏覽 API,以確定您應用程式所需要的功能。
- 前往 API 目錄,以確定適合您應用程式的 API。
- 選擇 API,檢視其概覽、更新記錄及主要功能。

- 瀏覽 API 文件詳細了解各要求和回覆的內容、您所選編程語言的示例、錯誤代碼及其他資訊。

- 請查閱公告,以了解預定的服務更新及最新消息。
步驟 2:
註冊或登入,以開始整合 FedEx API。
- 使用您的 fedex.com 用戶 ID 及密碼登入,開始整合 FedEx API。
- 如果您尚未擁有用戶 ID,請免費註冊用戶 ID。
步驟 3:
建立或加入組織。
加入您公司現有的組織,如您的公司尚未建立組織,請建立一個組織。您可以為一個組織聯繫多名用戶,但一個用戶 ID 不能與多個組織聯繫。
如果您建立組織,將自動成為該組織的管理員。管理員可邀請用戶加入組織,指派用戶身份及項目,並可以管理託運帳戶。如要了解各個身份適合指派的人員,請細閱我們的組織管理指南。如要建立您自己的組織,請按我的項目,然後按「建立組織」按鈕。此按鈕僅會在您的用戶 ID 尚未與現有組織有關聯時顯示。按下按鈕後,您就可以依照下列步驟 (* 號標記的項目為選填項目),開始建立組織:
- 請輸入組織名稱。
- 請輸入您希望邀請的團隊成員之電郵地址。這些成員加入後將自動成為審閱員,且不會與任何項目相關聯。*

您亦可以依照下列步驟,加入您公司的組織:
- 如您的公司已建立組織,請請求組織管理員邀請您加入。邀請有效時間為 24 小時,但如果您未能在此時段內接受邀請,您可以請求管理員再次發出邀請。
- 如要接受邀請,您需要憑您現有的用戶 ID 及密碼登入,如您現有的用戶 ID 已經與另一個組織有關聯,則需要建立新用戶 ID。
步驟 4:
新增託運帳戶。
管理員可以為組織新增所需的託運帳戶,數量不限。如要新增帳戶,請在管理組織頁面內的託運帳戶分頁按下「新增帳戶」按鈕。按下按鈕後,您就可以依照下列步驟,將現有託運帳戶新增至您的組織:
- 填寫帳戶資料
請輸入您帳號及任何與本帳戶相關聯的帳戶暱稱及帳單地址。這些資料將被驗證,以確保與帳戶詳情相符,防止欺詐行為。
如要檢視與您用戶 ID 相關聯的託運帳戶,請前往「託運管理員」頁面。如要建立新的託運帳戶,請聯絡您的 FedEx 銷售代表。

- 最終使用者授權合約
然後,您必須接受或寄給最終使用者公司合適的一方接受最終使用者授權合約 (EULA)。您可以在管理組織頁面內的託運帳戶分頁檢視最終使用者授權合約的狀態。

步驟 5:
為您的組織新增用戶,以開始與團隊成員合作。
管理員可邀請用戶加入他們的組織,並為用戶指派身份及項目。如要邀請用戶,請在管理組織頁面內的用戶分頁按下「新增用戶」按鈕。按下按鈕後,您就可以依照下列步驟,新增用戶 (* 號標記的項目為選填項目):
- 請輸入您需要加入至組織的用戶之電郵地址。如要輸入多個電郵地址,請按鍵盤上的空格、逗號、分號或輸入鍵。
- 如預設的審閱員身份並不適合該用戶,請為其選擇身份。*
- 為用戶編配與您的組織連繫的項目。如您尚未建立項目,下一步將指引您如何建立項目。*

管理員永遠都能存取所有項目,但研發員或審閱員則必須先獲指派項目,除非該項目由研發員建立。無論用戶接受邀請與否,您都可以先在組織管理頁面的用戶分頁快速更新用戶的項目或身份。只需按一下身份或項目旁的插入符號,隨即出現下拉清單,讓您選擇各種選項。選擇完畢後,請按「套用」按鈕儲存選擇。

步驟 6:
建立項目,以取得憑證。
在我的項目頁面,管理員或研發員可按下「建立項目」按鈕建立項目。按下按鈕後,您就可以依照下列步驟,開始建立項目 (* 號標記的項目為選填項目):
1. 建立項目
- 為項目命名,名稱應容易辨識,並且是組織內獨一無二的名稱。
- 先選擇新增最少一項 API 至您的項目。您稍後可以隨時新增或移除 API。

2. 接受條款
- 請詳閱並接受Developer Portal 授權合約,並確認您無意分銷您的應用程式。

- 選擇您打算在其境內託運的任何國家/地區,以便我們為您分配測試託運帳戶。如要測試歐洲國家/地區的本地包裹託運,您必須擁有每一個國家/地區的獨立測試帳戶。您稍後可以隨時新增/移除國家/地區。*
- 如果您打算使用 FedEx Ground® Economy Returns 或 FedEx Freight® LTL,請選擇「是」。*
- 按下「建立」按鈕後,您將看到確認畫面。您現在可以在您的新項目中檢視測試憑證。

步驟 7:
將 API 整合至您的應用程式,測試實際操作。
- 在項目概覽頁面的測試金鑰分頁取得測試憑證 (API 金鑰、秘密金鑰及託運帳戶)。

- 請求取得 OAuth 存取令牌,每一項 API 交易均須使用該令牌。令牌僅有效 1 小時,因此您須在應用程式內編寫代碼,在令牌過期前更新令牌。請參閱 API 授權文件,以了解詳情。
- 請選擇測試金鑰頁面內的 API 文件,並細閱業務背景,以深入了解所選 API 的用法。請檢視與所需整合工作相符的終端要求示例。
- 請按照要求示例所述執行您的終端指示,設定使用您的測試憑證。
- 確認所收到的 API 執行指示的回覆與文件中所述相符。
- 在 FedEx 測試環境中使用測試憑證及 FedEx 測試網址,完整地測試實際操作。
步驟 8:
將您的項目轉換為正式版。
於項目概覽頁面,請按一下正式版金鑰分頁。按下分頁後,您就可以依照下列步驟,開始將您的項目推出為正式版 (* 號標記的項目為選填項目):
- 設定項目。
- 為正式版 API 金鑰重新命名。*
- 需要在此時新增一個託運帳戶,但在項目成功轉換為正式版後,您可以新增更多帳戶。如果您沒有任何與組織聯繫的託運帳戶,或是組織內已新增的託運帳戶尚未簽妥最終使用者授權合約,下拉清單中將不會顯示這些帳戶。

- 取得項目金鑰。
- 接著將會顯示您的正式版 API 金鑰及正式版秘密金鑰。請確保您已複製並在安全地方儲存這些金鑰。
- 為保障您的秘密金鑰安全,我們僅會顯示該金鑰一次。如果您遺失金鑰,則需要產生新的金鑰。

步驟 9:
完成整合。
- 部分 API 需要有基本或託運標籤認證,方可在正式版環境中使用。請完成項目中所有需要此認證的 API 之認證程序。

- 所有 API 已獲認證及啟用後,請將測試網址、金鑰及託運帳戶替換為正式版網址、金鑰及託運帳戶,以更新您的 API 請求
- 請使用示例數據在正式版環境中重新測試實際操作。
- 享受全新整合工作所帶來的好處吧!
不是開發人員,或是不肯定您是否已準備好整合 FedEx API?了解整合對您企業的用處。
步驟 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:
索取正式版秘密金鑰。
- 您需要點擊秘密金鑰欄位的索取秘密金鑰連結,以索取秘密金鑰。
- 現在您可以使用示例數據,在正式版環境中重新測試實際操作。
- 享受全新整合工作所帶來的好處吧!