沙箱模式
使用沙箱功能可安全地進行測試
我們的免費沙箱功能可讓您測試 Expedia API 產品。您在沙箱下進行的測試設定不會反映在生產應用程式中,反之亦然。
沙箱模式功能如下:
- 以安全無風險的方式試用已啟用沙箱的產品
- 建立沙箱專屬 API 客戶端
- 根據需要更新沙箱產品設定
- 使用我們的 API Explorer、Postman 或其他工具測試沙箱端點
存取沙箱模式
登入 Expedia Group 控制台,並選擇一個帳戶。您第一次存取沙箱功能時,我們會建立一個沙箱帳號,用以模擬您存取沙箱時所使用的合作夥伴帳號。
有兩種方法可進入沙箱模式。
1. 使用全域切換
在左下角點選您的帳戶名稱,前往合作夥伴帳戶選單。
在帳戶彈出選項上,按一下沙箱模式切換開關將其開啟。
處於沙箱模式時,您可以進行變更,而不會影響您的生產應用程式。您只會在產品目錄中看到已啟用沙箱的產品。
當您準備好返回上線模式時,請再次將帳戶彈出選項的開關切換為關閉。
2. 從產品詳情頁面試用產品
前往產品目錄並找到您想試用的產品。可使用沙箱功能的產品會顯示標誌。
按一下可使用沙箱功能的產品,您就會進入產品詳情頁面。按一下頁面上方試用產品的按鈕,就可切換至沙箱模式並執行測試設定。
若想返回上線模式,可以按一下前往上線模式的連結,或回到帳戶彈出選項開啟全域切換。
在沙箱中設定產品
初步設定
在可使用沙箱功能的產品之產品詳情頁面上,按一下試用產品,即可開啟沙箱模式中的設定程序。
更新
- 使用全域切換開關開啟您的沙箱帳戶。
- 進入您要更新的產品之產品詳情頁面。
- 打開環境選單 (右上角三個垂直的點) 並選擇更新設定,即可開啟設定程序。
注意:您的上線帳戶也有相同的環境選單,因此請務必切換到沙箱帳戶以避免發生錯誤。您的沙箱選項需手動更新至您的線上設定。
建立 API 客戶端
若要使用 Expedia Group 旅遊平台 API (不論是沙箱或線上模式),您必須建立一個或多個 API 客戶端,也就是類似於使用密碼保護的使用者帳戶。基本上,API 客戶端證實傳送 API 請求的軟體屬於您 (驗證),並允許您限制每個客戶端能夠傳送的 API 請求類型 (授權)。有兩種方法可建立 API 客戶端:
- 按一下產品詳細資料頁面上的上下文選單,然後選擇建立 API 客戶端。
- 按一下左側導覽功能表中的建立 API 客戶端。
在「建立 API 客戶端」頁面輸入名稱及說明,能幫助您和組織中的其他人記得該客戶端所包含的產品。在可提供的產品清單中選擇包含的範圍 (API 請求類型)。注意:勾選上層的方塊將連帶選取所有子項目。
按一下建立。
建立 API 客戶端後,您將看到一個確認畫面,其中包含您的登入 ID 和密鑰。**這些資訊僅顯示一次,請務必複製登入 ID 和密鑰並儲存到安全位置。**請勿將您的客戶端 ID 和密鑰儲存在如 GitHub、客戶端程式碼等可公開存取的區域。
產品與使用範圍
所有 API 用戶端皆在單一合作夥伴帳戶下執行。當您將產品新增至帳戶時,這些產品就可以包含在 API 用戶端中。您可以建立單一 API 用戶端,並授予一項或多項產品的存取權。
每項產品皆包括一組使用範圍,授予對特定要求類型的存取權。您指定的使用範圍,將控制用戶端被授權執行的操作。若有多項軟體服務傳送 API 請求,我們建議您為每項服務分別建立 API 客戶端,並僅選擇每個 API 客戶端需要的使用範圍。
測試 API
為沙箱產品建立 API 客戶端後,請於 Developer Hub 中前往您想測試的產品之 API Explorer 頁面。將 API 伺服器 URL 改成指向您的沙箱,並插入安全登入資訊。
API 正式上線
完成沙箱測試後,您可以建立上線版本的 API 客戶端供生產應用程式使用。
- 登入控制台。
- 在產品目錄中,前往您要新增的產品之產品詳情頁面。
- 按一下新增產品 (若該產品需要取得核准,則按一下申請新增)。
- 設定產品,就像在沙箱上一樣。
- 按一下送出。
- 建立上線 API 客戶端:按一下左側導覽功能表中的建立 API 客戶端。
- 一般來說,您會使用與沙箱相同的範圍。
- 按一下取得登入資訊。
注意:當您新增產品時,Expedia 團隊可能會聯絡您以取得更多資訊。
您也可以要求直接從沙箱模式上線,請找到前往上線模式的連結即可。
要了解如何在您的軟體中內嵌 API 客戶端,詳見 API 驗證與授權。