開始使用

運用 FedEx API 帶來的各種優勢,開始您的整合工作。下列指示會引導您進行每一個步驟,設定組織並建立專案,以及如何以電商兼容使用者身份開始整個流程。


步驟 1︰

瀏覽應用程式開發介面 (API),以確定應用程式所需的項目。

  • 前往 API 目錄,確定適用於您的應用程式的 API。
  • 選取一項應用程式開發介面 (API),以查看其總覽、變更記錄檔及關鍵功能
「費率概覽」頁面的螢幕截圖
  • 檢視應用程式開發介面 (API) 的文件,以深入瞭解關於請求與回應元件、所選程式語言的範例、錯誤代碼以及其他資訊。
「費率文件」頁面的螢幕截圖
  • 查看「公告」以瞭解預計的服務更新並獲取最新消息。

步驟 2︰

註冊或登入,開始與 FedEx 應用程式開發介面 (API) 進行整合。

  • 使用您的 fedex.com 用戶識別碼與密碼登入,開始與 FedEx API 進行整合。
  • 如果您還沒有用戶識別碼,您可以免費註冊

步驟 3︰

建立或加入一個組織。

如果您的公司還沒有組織,請建立一個組織;或加入公司現有的組織。您可以將多名用戶與您的組織建立關聯,但無法將多個組織與單一用戶識別碼建立關聯。

如果您的組織是由您所建立,系統會自動將您列為該組織的管理員。管理員可以邀請使用者加入其組織、為其指定角色與專案,以及管理託運帳戶。若要深入瞭解如何決定最適合使用者的角色,請檢視我們的「組織管理指南」。若要建立您自己的組織,請按一下「我的專案」,然後按一下「建立組織」按鈕。只有在您尚未將用戶識別碼與現有組織建立關聯的情況下,才會顯示此按鈕。接著,請完成下列各項步驟,即可開始建立組織 (有「*」標記的步驟為選用步驟):

  • 輸入組織名稱。
  • 輸入您想要邀請的任何團隊成員的電子郵件地址。系統會自動將其作為「檢視者」加入,但不會與任何專案建立關聯。*
「建立組織」頁面的螢幕截圖

您也可以藉由下列步驟來加入公司的組織:

  • 如果貴公司已建立組織,請要求該組織的管理員邀請您加入。請在 24 小時內接受邀請;如果錯過此時限,您可以請管理員重新傳送邀請給您。
  • 若要接受邀請,您需要使用現有的用戶識別碼與密碼登入;或者,如果您現有的用戶識別碼已與某個組織建立關聯,則需要建立一個新的用戶識別碼。

步驟 4︰

新增一個託運帳戶。

管理員可依據組織的需要來新增任意數量的託運帳戶。若要開始,請於「組織管理」頁面的「託運帳戶」索引標籤中,按一下「新增帳戶」按鈕。接著,請完成下列各項步驟,即可將現有的託運帳戶新增至您的組織:

  1. 完整填寫帳戶資訊
  • 輸入您的帳戶號碼、任何帳戶暱稱以及與帳戶相關聯的帳單地址。這項資料將會進行驗證,確認其與帳戶詳細資料相符,以防範詐騙活動。

  • 若要檢視與您的用戶識別碼相關聯的託運帳戶,請前往「託運管理」頁面。若要建立新託運帳戶,請聯絡您的 FedEx 銷售代表。

「新增寄件帳戶」頁面的螢幕截圖
  1. 使用者授權合約
「執行使用者授權合約」頁面的螢幕截圖

步驟 5︰

將使用者新增至組織中,開始與您的團隊成員協同作業。

管理員可以邀請使用者加入其組織,並為其指定角色與專案。若要開始,請於「組織管理」頁面的「使用者」索引標籤中,按一下「新增使用者」按鈕。接著,請完成下列各項步驟,即可新增使用者 (有「*」標記的步驟為選用步驟):

  1. 輸入需要加入組織的使用者的電子郵件地址。您可以使用空格、逗號、分號或 Enter 鍵來輸入多個電子郵件地址。
  2. 如果預設的「檢視者」角色不符合使用者需求,請另外選擇一種角色。*
  3. 選擇一項與您的組織相關聯的專案,以指定給使用者。如果您尚未建立專案,將於下一個步驟中說明。*
「新增使用者」頁面的螢幕截圖

管理員將永遠具有對所有專案的存取權限,而貢獻者或檢視者則必須被指定至某一專案,若專案是由該貢獻者所建立則除外。無論用戶是否接受邀請,您都可以直接在「組織管理」畫面的「用戶」索引標籤中快速更新其專案或角色。只要按一下角色或專案旁的插入符號,就會顯示一個下拉清單,您即可從其中所包含的選項進行選擇。選擇完畢之後,請選取「套用」按鈕儲存選取項目。

「管理組織」頁面的螢幕截圖

步驟 6︰

建立一項專案以取得認證。

「我的專案」頁面中,管理員或貢獻者可以選取「建立專案」按鈕來建立專案。接著,請完成下列各項步驟,即可開始建立專案 (有「*」標記的步驟為選用步驟):

1.  設定專案        

  • 為專案設定一個貴組織專屬的識別名稱。
  • 首先,請選取至少一個要新增至專案的應用程式開發介面 (API)。您之後可以隨時新增或移除 API。           
步驟 1 建立專案的螢幕截圖

2. 接受條款

步驟 2 建立專案的螢幕截圖
       
         3.  設定專案
 
  • 選取您計畫在其境內進行託運的任何國家/地區,以便我們為您指派測試託運帳戶。若要在歐洲國家/地區測試國內包裹託運,您必須針對每個國家/地區建立個別的測試帳戶。您之後可以隨時新增或移除國家/地區。*
  • 如果您打算使用 FedEx Ground® Economy 或 FedEx Freight® 零擔貨運 (LTL),請選取「是」。*
  • 按一下「建立」按鈕後,確認畫面會隨即顯示。現在,您可以在新專案中檢視您的測試認證。 
步驟 3 建立專案的螢幕截圖

步驟 7:

將應用程式開發介面 (API) 整合至您的應用程式中,並測試實作。

  1. 在「專案總覽」頁面的「測試金鑰」索引標籤中,擷取測試認證 (API 金鑰、秘密金鑰及託運帳戶)。
測試金鑰頁面的螢幕截圖
  1. 要求一個必須與每個應用程式開發介面 (API) 交易一起使用的 OAuth 存取權杖。權杖工作階段的有效時間只有一小時,因此您必須將應用程式的程式碼設計為可於工作階段逾期之前重新整理權杖。如需更多詳細資訊,請參閱「應用程式開發介面 (API) 授權」文件。
  2. 在「測試金鑰」頁面中選取 API 文件,並詳閱業務內容,充分瞭解如何使用選取的 API。檢閱與您所需整合相符的端點範例要求。
  3. 依範例要求中所述,對這些端點實作您的要求,將它們設定為使用您的測試認證。
  4. 確認收到的 API 要求回應與文件中所顯示的相符。
  5. 使用測試認證與 FedEx 測試 URI,在 FedEx 測試環境中完整測試您的實作。

步驟 8:

將專案移入生成程序。

在「專案總覽」頁面中,按一下「生成金鑰」索引標籤。接著,請完成下列各項步驟,即可開始將您的專案移入生成程序 (有「*」標記的步驟為選用步驟):

  1. 設定專案。
  • 重新命名您的生成 API 金鑰。*
  • 此時需要新增一個託運帳戶,但您可以在專案成功移入生產程序之後新增更多託運帳戶。如果您沒有與組織相關聯的託運帳戶,或者如果還沒有為已新增至組織的託運帳戶簽署 EULA,它們將不會顯示在下拉清單中。
步驟 1 產生金鑰頁面的螢幕截圖
  1. 取得專案金鑰。
  • 接下來,將會顯示您的生成 API 金鑰及生成秘密金鑰。請務必將其複製至安全保存之處。
  • 為了確保生成秘密金鑰的安全,我們只會顯示一次。如果您不慎遺失,可以產生一個新的生成秘密金鑰。
步驟 2 產生金鑰頁面的螢幕截圖

步驟 9:

完成整合。

  1. 某些 API 需要有基本或託運標籤認證,才能在我們的生成環境中使用。為滿足此要求,您需要完成專案中所有 API 的認證程序。
認證頁面的螢幕截圖
  1. 所有的 API 均經過認證並啟用之後,請將測試 URI、金鑰及託運帳戶替換為生成 URI、金鑰及託運帳戶,以更新您的應用程式開發介面 (API) 要求
  2. 在生成環境中使用範本資料重新測試您的實作。
  3. 享受全新整合為您帶來的效益!


步驟 1:

FedEx 會建立 兼容 供應商組織。

  • FedEx 會建立組織,接著邀請一名團隊成員加入組織。FedEx 會指派該使用者擔任組織的「管理員」。
  • 完成認證與整合後,您就能輕鬆配送解決方案給客戶

步驟 2︰

接受邀請。

  • 若要存取應用程式開發介面 (API) 整合品項與文件,請接受邀請。若要接受邀請,您需使用 FedEx 用戶識別碼與密碼登入;如果您仍未擁有認證,請建立新的認證。
「登入以開始與 FedEx API 進行整合」頁面的截圖

步驟 3︰

邀請使用者加入您的組織。

  • 成為管理員後,您就能邀請任何需要存取專案或組織的團隊成員加入。如需不同角色的詳細資料,請參閱組織管理指南
「管理組織使用者」頁面的截圖
  • 如果您的組織已建立完成,請要求組織管理員或 FedEx 邀請您加入。請在 24 小時內接受邀請;如果錯過此時限,您可以請管理員重新傳送邀請給您。

步驟 4︰

選取解決方案所需的應用程式開發介面 (API)。

  • 前往應用程式開發介面 (API) 目錄,確定您的解決方案適合哪個 API。FedEx 客戶技術顧問 (CTC) 和兼容管道管理員可依照您的業務需求,協助您選取適合您解決方案的 API。

「API 目錄」頁面的截圖
  • 選取應用程式開發介面 (API),以探索總覽畫面、變更記錄及重要功能。

「地址驗證 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) 整合至您的應用程式,並完成 兼容 計畫認證作業。

  1. 目前您已可以存取測試應用程式開發介面 (API) 金鑰和測試秘密金鑰,開始執行交易項目。您可以前往「專案總覽」頁面的「測試金鑰」索引標籤,擷取這些金鑰。
「專案總覽測試版金鑰索引標籤」頁面的截圖
  1. 若要建立客戶金鑰,您需使用認證註冊應用程式開發介面 (API),這種個人專用的 API 僅會顯示於各專案的 API 區段。
  2. 建立數個客戶金鑰後,請接著索取 OAuth 存取權杖,以供各應用程式開發介面 (API) 交易使用。權杖工作階段的有效時間只有一小時,因此您必須設計應用程式的程式碼,使其可在工作階段逾期前重新整理權杖。如需詳細資訊,請參閱應用程式開發介面 (API) 授權文件。檢視範例程式碼時,請務必從範例下拉清單選擇「經銷商」。
「認證註冊 API 的範例程式碼『範例』下拉清單」頁面的截圖
  1. 在「測試金鑰」頁面中選取 API 文件,並詳閱業務內容,充分瞭解如何使用選取的 API。檢閱與您所需整合相符的端點範例要求。
  2. 依範例要求中所述,對這些端點實作您的要求,將它們設定為使用您的測試認證。
  3. 確認收到的 API 要求回應與文件中所顯示的相符。
  4. 使用測試認證與 FedEx 測試 URI,在 FedEx 測試環境中完整測試您的實作。
  5. 完整測試解決方案後,請認證 Salesforce 中的每個解決方案。FedEx 會完整審核您提交的所有解決方案,並在您的認證通過核准後通知您。

步驟 7:

FedEx 會將專案移入生成程序。

  • 接著,FedEx 會將專案移入生成程序。
  • 之後,您就能在「專案總覽」頁面的「正式版金鑰」索引標籤下,檢視正式版 API 金鑰
「專案總覽正式版索引標籤顯示產生連結的 Compatible 版本」頁面的截圖

步驟 8:

產生生產程序專用的秘密金鑰。

  • 您必須按一下「秘密金鑰」欄位下方的「產生密碼」連結,系統才會為您產生生成秘密金鑰。
  • 現在您可以使用範例資料,在生成環境中重新測試實作項目了。
  • 享受全新整合為您帶來的效益!