使用入門
FedEx Developer Portal提供一套FedEx應用程式設計介面(API),讓您將FedEx整合至自己的應用程式中。本指南將引導您建立組織、建立項目、測試整合方案、將項目轉換為正式版,並在部分情況下完成API驗證。
用戶類型:
FedEx為三類用戶提供整合服務:FedEx寄件人、經驗證的軟件解決方案供應商(亦稱為FedEx Compatible供應商),以及經驗證的FedEx整合供應商。
FedEx寄件人:
利用FedEx託運服務,並需將FedEx API整合至自家應用程式的公司。
解決方案或服務供應商:
需整合FedEx API,以建立可供外部組織使用FedEx託運服務銷售及/或分送的解決方案、應用程式或插件的公司。
- FedEx Compatible供應商:經FedEx Compatible計劃驗證並簽訂合約的公司。
- FedEx整合供應商:經FedEx整合商計劃認證並簽訂合約的公司。
請從下方選擇最貼切描述您公司業務的選項。無論您是哪類用戶,都可找到適合您的入門指引。
請選擇以開始體驗。
如您的公司沒有組織,請建立組織。否則,請加入現有組織。
建立新組織
在導覽列中,點擊「建立或加入組織」。
注意:您作為建立者,將自動被指派為管理員。
管理員可以:
邀請用戶加入
指派用戶角色(例如:研發員、審閱員)及項目
管理託運帳戶
有關各個角色的更多資訊,請參閱我們的《組織管理指南》。
對於公司類型,請選擇「出售或提供使用FedEx技術的軟件解決方案,且公司是經驗證的FedEx整合供應商」。
提供您的公司名稱、網站網址及唯一的組織名稱。組織名稱可與您的公司名稱相符,或者代表特定的群組(部門、分部、地區、地點)。這些資料為必填,以驗證您的要求。
注意:請選擇所有其他用戶都能識別的組織名稱(例如公司名稱、部門、地區、地點)。
指明您公司的地點,以及您公司的軟件解決方案的銷售或分銷地點。
新增付款帳戶並驗證帳戶
注意:您作為FedEx整合商計劃的託運及物流供應商,必須使用自己的帳號。您不得使用顧客的FedEx帳戶。
輸入您的FedEx帳戶號碼。若您尚未擁有FedEx帳戶,請於fedex.com開立帳戶或聯絡FedEx支援代表。
輸入帳戶暱稱,以及與帳戶聯繫的帳單地址。選擇「下一步」。
注意:帳單地址必須與此帳戶於系統上的記錄相符。這將作為貴組織的預設付款帳戶。
您必須驗證您的帳戶,方可完成建立貴組織。選擇驗證選項(電話僅適用於美國和加拿大的整合商,其他國家/地區的整合商可選擇電郵或短訊),然後選擇「下一步」。
收到後輸入驗證碼,並選擇「提交」。
接受條款
請閱讀《全球整合商協議》和《計劃手冊》。選擇確認方格以確認您接受條款,然後選擇「接受」。
螢幕上將顯示確認訊息。如有需要,請點擊「管理組織」以編輯詳細資料。
邀請用戶
注意:僅限管理員可邀請用戶。
從左側導覽欄選擇「管理組織」。
前往「用戶」索引標籤,並選擇「新增用戶」。
填寫表格,並為新用戶指派適當的角色:審閱員、研發員或管理員。
如欲進一步了解用戶角色,請參閱《組織管理指南》。
在「項目」下拉清單下,為用戶指派項目(如適用)。
輸入每位用戶的電郵地址,然後選擇「邀請」。
加入現有組織
要求邀請:請貴組織的管理員向您傳送邀請。您需在24小時內接受,否則邀請將會過期。如有需要,可要求管理員重新傳送。
接受邀請:利用您現有的用戶ID和密碼登入。如您的ID已連結至另一個組織,您必須建立新的ID。
加入現有組織
第1步:要求貴組織的管理員向您發送邀請。
如貴公司已建立組織,請要求組織管理員邀請您加入。邀請有效時間為 24 小時。如果您未能在此時段內接受邀請,您可以請求管理員再次發出邀請。
第2步:接受邀請。
如要接受邀請,您需要憑您現有的用戶 ID 及密碼登入,如您現有的用戶 ID 已經聯繫另一個組織,則需要建立新用戶 ID。
建立 API 項目
瀏覽我的項目頁面,並開啟API分頁。點擊建立API項目按鈕。
第1步:選擇您希望加入項目中的API
檢查API配額、速度限制及API驗證詳細資訊。
第2步:設定項目詳細資訊
- 為項目命名,名稱必須容易辨識,並且是組織內獨一無二的名稱。
- 選擇您打算在其境內託運的任何國家/地區,以便我們為您分配測試託運帳戶。如要測試歐洲國家/地區的本地包裹託運,您必須就每一個國家擁有一個獨立測試帳戶。您稍後可以隨時新增/移除國家/地區。
- 如要取得有關最新 API 更新的通知,以及任何與服務中斷相關的資訊,請設定通知偏好。
第3步:閱讀並接受條款,包括FedEx Developer Portal授權協議
接受條款並點擊「建立」按鈕後,您將看到確認畫面。此時您可以在新項目中檢視測試憑證。
建立 Webhook 項目
在目的地應用程式或平台中建立有效的(回調)網址
您的目的地網址將用於接收FedEx發送的驗證碼、訊息和Webhook數據通知。您的網址必須使用HTTPS,以確保安全性。如包含下列任何內容,您的網址將被封鎖:
- RFC1918 IP空間
- fedex.com或其任何子網域
- 網址中的 IP 位址 (包括本機主機,127.0.0.1)
產生安全令牌
此安全令牌可用作秘密金鑰,以授權及驗證貴組織與FedEx之間傳輸的資料。您的安全令牌必須包括:
- 必須至少有26個字元,最多為100個字元
- 1 個大寫字母
- 1 個小寫字母
- 1 個數目字
範例:Y1F6OiVUQW2JPSElmRE9U0IY5
定義網址和安全令牌後,便可建立Webhook項目。瀏覽我的項目頁面,並開啟Webhook分頁。點擊建立Webhook項目按鈕。
選擇訂閱類型
FedEx寄件人可訂閱帳號或查詢號碼的相關事件。
第1步:確認您的付款帳戶,並選擇功能
- 檢視預設列出的付款帳戶,以確認或從您的組織中選擇另一個付款帳戶。
- 選擇功能以配置您的項目,例如送達證明選項、預計送達選項、查詢事件和基於事件的篩選。
第2步:輸入項目詳情
- 為項目命名,名稱必須容易辨識,並且是組織內獨一無二的名稱。
- 輸入在預先設置驗證期間建立的目的地網址和安全令牌詳情(請參見以上步驟)。
- 如要取得有關最新Webhook更新的通知,以及任何與服務中斷相關的資訊,請輸入電郵地址和首選語言。
第3步:閱讀並接受條款
接受條款(包括《FedEx Developer Portal授權協議》和《訂單表格》)並點擊「建立」按鈕後,您將看到確認畫面。
根據您所選的訂閱類型,可能須完成額外步驟。請瀏覽說明文件了解詳情。
在API項目概覽頁面上,檢索您的測試憑證 — API金鑰、秘密金鑰,以及託運帳戶 — 檢索位置在測試金鑰分頁下方。
第1步:申請OAuth存取令牌
每項API交易均須使用OAuth存取令牌。令牌僅有效1小時,因此您須在應用程式內設定編碼,以便在失效前重新整理令牌。請參閱《API Authorization說明文件》了解詳細資訊。
第2步:檢視API說明文件
點擊各API說明文件以細閱業務背景,並了解API的使用方法。登入後,在說明文件頁面頂部點擊按鈕下載JSON API系列。您亦可以檢視與所需整合相符的端點請求示例。
第3步:使用沙盒測試範例交易
在左側導覽欄點擊所需的端點,前往該沙盒環境。找出與您的使用個案相符的範例請求,然後使用測試憑證和FedEx測試網址,依照範例請求中所述,向端點實施呼叫。驗證您收到的API執行指示的回覆是否與文件中所述相符。如需進一步了解我們的測試體驗,請參閱《沙盒虛擬化指南》。
利用Webhook測試
測試有助您清晰了解您建立的網址是否有效。測試亦能讓FedEx識別您的網址,並與您的網址建立連接以傳送數據。測試亦能為您提供樣本測試數據,協助您檢查並確認自己能否處理應用程式中提供的查詢數據。然而,測試無法授權驗證您的網址。請瀏覽我們的Webhook說明文件,了解如何測試您的Webhook網址。
前往您的項目概覽頁面,並開啟正式版金鑰分頁。「進階集成可見性」帳號訂閱項目無需轉換為正式版。
第1步:配置項目
- 按需要重新命名金鑰。
- 查看您在項目建立流程第 1 步所選擇的帳號。這用於將您的項目轉換為正式版。當您的項目轉換為正式版後,您可以按需要新增更多帳戶。
第2步:取得項目金鑰
複製您的正式版API金鑰及正式版秘密金鑰,並儲存至安全位置。為保障您的正式版秘密金鑰安全,我們僅會顯示該金鑰一次。如果您遺失金鑰,便需要產生新的金鑰。
當您取得項目金鑰並點擊下一步後,項目詳情將在正式版金鑰分頁上顯示。
- 如需為項目新增更多託運帳戶,請點擊託運帳戶表格頂部的編輯。
部分API需要有託運標籤驗證,方可在我們的正式版環境中使用。查看您的API是否需要驗證。
第 1 步:開發及測試網頁應用程式的 FedEx API
您的網頁應用程式開發完成後,就是時候使用測試憑證 (測試託運帳戶、API 金鑰及秘密金鑰) 完成測試。您的測試 API 金鑰及秘密金鑰將於項目概覽頁面顯示,亦可以隨時存取。
第 2 步:將您的項目推出為正式版
使用FedEx API測試後,您需要展開驗證程序,先在FedEx Developer Portal將您的項目移至正式版。成為完成上述步驟後,您將會看到您的正式版API金鑰及秘密金鑰。您的正式版金鑰僅會顯示一次,但您能日後再重新產生金鑰。
第 3 步:填寫標籤封面表
請依照適宜的聯絡資料及您計劃實施的服務填妥標籤封面頁。包括您的帳號及正式版金鑰。
第4步:產生測試標籤,並提交至條碼分析團隊
在與應用程式有關的FedEx測試環境中產生測試標籤,然後將測試標籤提交至FedEx標籤評估團隊,以取得批准。條碼分析團隊須要三個工作天的周轉時間完成標籤評估。
請遵循以下最佳做法,以免處理延誤:
- 標籤列印及掃瞄時最少必須有600 DPI。切勿寄發 API 所產生的檔案。
- 如使用熱敏打印機,標籤圖像類型的請求須根據打印機型號發出。例如:ZPLII適用於Zebra打印機。
- 建立評估用示例標籤時,請使用寄件人/收件人地址資料。請只根據所申請的指定服務建立示倩標籤。請只根據所申請的指定服務建立示倩標籤。
- FedEx®貨到付款(C.O.D.)標籤必須包含相應的貨到付款回件標籤。
- FedEx International Express®貨件亦必須包括輔助/次要空運提單(AWB)標籤。
- 多包裹貨件 (MPS) 必須包含貨件內每一件包裹的標籤。
- 將PDF及標籤封面頁電郵至:label@fedex.com。
- 實物標籤可寄往下列地址:
FedEx服務
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
如果已掃瞄的標籤沒有可見的錯誤(如劃過條碼的線條、墨水中的斑點或物理上的損壞),那麼就能通過檢查,並獲得批准。
如寄發實物標籤,請留意列印品質及意外將標籤放大/縮小 (如比例設定)。上述是標籤未能通過標籤評估程序的兩大原因。
第5步:檢視標籤評估
條碼分析團隊將評估所提交的測試標籤,並批准或拒絕標籤。條碼分析團隊將聯絡您,並告知所提交標籤的批准或拒絕原因。如標籤獲批准,請繼續下一步。如標籤遭拒絕,請按指示修正標籤,並重新提交。
第6步:啟用應用程式
測試標籤獲條碼分析團隊批准推出正式版後,團隊將授予您正式版的憑證,讓您可以發送已識別的託運標籤交易,並透過電郵通知您驗證成功。項目的批准乃逐個發出。
第 7 步:替換網址及憑證
將測試網址及測試憑證替換為正式版網址及正式版憑證。 請使用示例數據在正式版環境中重新測試實際操作。
第1步:收到加入組織的邀請
FedEx 將建立組織並邀請一名團隊成員加入。該名用戶將被指定為您組織的管理員。
第2步:接受邀請
如要接受邀請,您需要憑您現有的用戶 ID 及密碼登入,如您現有的用戶 ID 已經聯繫另一個組織,則需要建立新用戶 ID。
第3步:邀請用戶
管理員可邀請用戶加入他們的組織,並為用戶指派身份及項目。開啟「用戶」分頁。點擊「新增用戶」按鈕。
- 選擇用戶身份:檢視者、貢獻者或管理員。參閱我們的《組織管理指南》,進一步了解各個身份。
- 若您已有現有項目,請將項目分配予該用戶。您亦可在任何「項目」概覽頁面下,將用戶分配至項目中。
- 請輸入您希望以所選身份加入您組織之用戶的電郵地址。
瀏覽API目錄,因應您的解決方案找出合適的API或Webhook。您的FedEx客戶技術顧問(CTC)和Compatible Channel經理可以根據您的業務需要,協助您選擇適合解決方案的API。
第1步:填寫PIW
返回Compatible供應商社群(CPC),填寫「產品資訊工作表」(PIW)。
第2步:檢視FedEx建立的項目
PIW一經審核,FedEx便會為您建立項目。您每個解決方案的每個版本,都會在FedEx Developer Portal上設有獨立的項目。
第3步:與您的團隊一同參與API示範
FedEx Compatible團隊和FedEx CTC及驗證團隊為您的團隊籌辦API技術示範時亦然。FedEx團隊將探討「Compatible計劃驗證」、新的API功能和效用,並解答問題。
在API項目概覽頁面上,檢索您的測試憑證— API金鑰和秘密金鑰 — 檢索位置在測試金鑰分頁下方。
第1步:建立客戶金鑰
使用「註冊憑證API」建立客戶金鑰。此為私人API,僅可在API項目概覽頁面底部的API部分中找到。
第2步:申請OAuth存取令牌
每項API交易均須使用OAuth存取令牌。令牌僅有效1小時,因此您須在應用程式內設定編碼,以便在失效前重新整理令牌。請參閱《API Authorization說明文件》了解詳細資訊。檢視示例代碼時,確保示例下拉清單中選擇了「轉售商」。
第3步:檢視API說明文件
點擊各API說明文件以細閱業務背景,並了解API的使用方法。登入後,在說明文件頁面頂部點擊按鈕下載JSON API系列。您亦可以檢視與所需整合相符的端點請求示例。
第4步:使用沙盒測試範例交易
在左側導覽欄點擊所需的端點,前往該沙盒環境。找出與您的使用個案相符的範例請求,然後使用測試憑證和FedEx測試網址,依照範例請求中所述,向端點實施呼叫。驗證您收到的API執行指示的回覆是否與文件中所述相符。如需進一步了解我們的測試體驗,請參閱《沙盒虛擬化指南》。
第5步:驗證各項解決方案
完成測試解決方案後,請向驗證團隊提交測試案例,以驗證各項解決方案。FedEx將全面審查一切提交內容,並在認證獲批後通知您。
利用Webhook測試
若您的組織擁有Webhook存取權限,有助您清晰了解您建立的網址是否有效。測試亦能讓FedEx識別您的網址,並與您的網址建立連接以傳送數據。測試亦能為您提供樣本測試數據,協助您檢查並確認自己能否處理應用程式中提供的查詢數據。然而,測試無法授權驗證您的網址。請瀏覽我們的Webhook說明文件,了解如何測試您的Webhook網址。
然後,FedEx 會將您的項目轉換為正式版。前往您的API項目概覽頁面,並開啟正式版金鑰分頁。點擊秘密金鑰直欄下的產生秘密金鑰連結。
現在您可以使用示例數據,在正式版環境中重新測試實際操作。
加入您公司現有的組織,如您的公司尚未建立組織,請建立一個組織。
建立新組織
在導覽列中,點擊「建立或加入組織」。
注意:您作為建立者,將自動被指派為管理員。
管理員可以:
邀請用戶加入
指派用戶角色(例如:研發員、審閱員)及項目
管理託運帳戶
有關各個角色的更多資訊,請參閱我們的《組織管理指南》。
對於公司類型,請選擇「出售或提供使用FedEx技術的軟件解決方案,且公司是經驗證的FedEx整合供應商」。
提供您的公司名稱、網站網址及唯一的組織名稱。組織名稱可與您的公司名稱相符,或者代表特定的群組(部門、分部、地區、地點)。這些資料為必填,以驗證您的要求。
注意:請選擇所有其他用戶都能識別的組織名稱(例如公司名稱、部門、地區、地點)。
指明您公司的地點,以及您公司的軟件解決方案的銷售或分銷地點。
新增付款帳戶並驗證帳戶
注意:您作為FedEx整合商計劃的託運及物流供應商,必須使用自己的帳號。您不得使用顧客的FedEx帳戶。
輸入您的FedEx帳戶號碼。若您尚未擁有FedEx帳戶,請於fedex.com開立帳戶或聯絡FedEx支援代表。
輸入帳戶暱稱,以及與帳戶聯繫的帳單地址。選擇「下一步」。
注意:帳單地址必須與此帳戶於系統上的記錄相符。這將作為貴組織的預設付款帳戶。
您必須驗證您的帳戶,方可完成建立貴組織。選擇驗證選項(電話僅適用於美國和加拿大的整合商,其他國家/地區的整合商可選擇電郵或短訊),然後選擇「下一步」。
收到後輸入驗證碼,並選擇「提交」。
接受條款
請閱讀《FedEx整合商協議》和《計劃手冊》。選擇確認方格以確認您接受條款,然後選擇「接受」。
螢幕上將顯示確認訊息。如有需要,請點擊「管理組織」以編輯詳細資料。
邀請用戶
注意:僅限管理員可邀請用戶。
從左側導覽欄選擇「管理組織」。
前往「用戶」索引標籤,並選擇「新增用戶」。
填寫表格,並為新用戶指派適當的角色:審閱員、研發員或管理員。
如欲進一步了解用戶角色,請參閱《組織管理指南》。
在「項目」下拉清單下,為用戶指派項目(如適用)。
輸入每位用戶的電郵地址,然後選擇「邀請」。
加入現有組織
要求邀請:請貴組織的管理員向您傳送邀請。您需在24小時內接受,否則邀請將會過期。如有需要,可要求管理員重新傳送。
接受邀請:利用您現有的用戶ID和密碼登入。如您的ID已連結至另一個組織,您必須建立新的ID。
建立API項目
前往「我的項目」頁面,然後選擇「建立專項目」。
填寫「項目名稱」欄位。建議使用「項目名稱_應用程式名稱」的名稱格式。完成後,選擇「下一步」。
為您的項目選擇API和Advanced Integrated Visibility產品。
注意:Advanced Integrated Visibility產品僅適用於美國FedEx整合供應商。
注意:若您選擇任何付費產品,系統將要求您為該項目指派付款帳戶,並接受必要的條款。
指派帳單並接受條款
從已新增至組織的帳戶清單中指派付款帳戶。僅當您先前已選擇付費產品時,才須執行此步驟。
接受該產品相關的條款及細則。
確認詳情
檢視已選擇的產品。驗證所提供的付款帳戶。
審閱並接受Fedex Developer Portal授權合約。
點擊建立以生成項目,並檢視測試憑證。
在項目中配置Advanced Integrated Visibility
先決條件
在目的地應用程式或平台中建立有效的回呼網址 — 您的應用程式/平台網址:
為安全起見,必須使用HTTPS。
不得包含RFC1918 IP空間、fedex.com子網域或直接IP位址(例如127.0.0.1)。
生成安全令牌
必須為26至100個字元,並包含:
- 1個大寫字母
- 1個小寫字母
- 1個數字
範例:Y1F6OiVUQW2JPSElmRE9U0IY5
配置Advanced Integrated Visibility
選擇Advanced Integrated Visibility。選擇功能,例如送達證明、預計送達、查詢事件和事件篩選條件。
輸入您的目的地網址和安全令牌。
提供電郵地址,以接收Advanced Integrated Visibility的更新和服務中斷通知。
確認詳情
審閱並接受《Fedex Developer Portal授權合約》和《訂單表格》。
選擇建立以完成設置。
注意:根據您的訂閱類型,可能需要執行其他步驟。詳情請參閱說明文件。
檢索「測試憑證」並「開始測試」
檢視API說明文件
- 請閱讀API說明文件,了解我們提供的各種API,以及其業務背景和整合流程。
- 從相關的API說明文件頁面下載「JSON架構」。
- 查看所需端點的要求範例。
取得測試憑證
在項目概覽頁面上,前往API金鑰索引標籤。您的API金鑰和秘密金鑰會列於「測試金鑰」標題下方。
檢視API說明文件
- 所有API交易均須提供OAuth令牌,該令牌會於一小時後過期。
- 您的應用程式必須在令牌過期前,重新整理令牌。
- 詳情請參閱《API Authorization說明文件》。
在沙盒中測試API交易
測試Advanced Integrated Visibility
Advanced Integrated Visibility測試會驗證您的網址格式,並協助在FedEx與您的應用程式之間建立連接。
此測試提供測試範本數據,以供處理查詢資料。
注意:測試無法驗證您的網址。
如需更多資訊,請瀏覽Advanced Integrated Visibility說明文件。
必須驗證,方可將API轉移至正式版。驗證層級API視乎API而異。
開發及測試FedEx API
- 使用您從「項目概覽」頁面取得的測試憑證(API金鑰和秘密金鑰)。
- 找出您計劃在地區/地域中部署解決方案的測試個案(請參閱「整合商測試個案基線」)。
- 在執行測試個案前,請先使用所提供的帳號完成註冊交易。
- 執行所有必要的測試個案。
前往您的「項目概覽」頁面。
選擇「索取正式版金鑰」。FedEx將收到您的正式版金鑰要求,並於批准後通知您。
填妥PIW和驗證封面頁
填寫產品資訊工作表(PIW)和整合商驗證封面頁,並提供您的聯絡資料和預期會使用的FedEx服務。
提交「交付項目」
為免受電郵供應商限制,請收集並將下列檔案壓縮為.zip檔案。傳送至validationmtp@fedex.com。
必要的「交付項目」
- 已填妥的PIW (PDF)。
- 已填妥的驗證封面頁 (PDF)。
螢幕截圖 (PDF):
顯示FedEx服務/特別處理的顧客解決方案
免責聲明
最終使用者授權合約協議
終端客戶註冊流程
- 終端顧客註冊交易和多重驗證 (JSON)
- 所有適用測試個案的託運標籤掃描本 (PDF/PNG)
- PDF、PNG和ZPL (JSON) 三種標籤格式的託運交易(用於適用的託運和評價API)
避免延誤的最佳做法
- 標籤必須以最低600 DPI列印及掃描。
- 熱敏式打印機標籤必須與打印機型號相符(例如ZPLII用於Zebra打印機)。
- FedEx International Express®貨件須附上輔助空運提單 (AWB) 標籤。
- 多包裹貨件 (MPS) 必須包含每件包裹的標籤。
標籤評估
驗證團隊將會批准或拒絕您提交的交付項目。
- 如驗證團隊拒絕,請作出更正,並根據意見重新提交
- 如驗證團隊批准,您將收到驗證成功的確認電郵。收到電郵後,您的正式版憑證將獲授權進行託運標籤交易。
遵循驗證後的指示
檢視並按需要實施所有驗證後要求。
當收到正式版金鑰的批准通知後,請前往「項目概覽」索引標籤檢索正式版金鑰。
- 複製並妥善保管您的正式版API金鑰和秘密金鑰。
- 秘密金鑰僅會顯示一次,如不慎遺失,您必須重新產生新的秘密金鑰。

