XAP API 沙盒使用指南
簡介
為了協助開發人員更有效率地建 置和測試整合功能,我們在「航班與住宿」領域下,針對一組精選的 API 提供沙盒環境。此環境透過模擬回應來模擬預期行為,協助合作夥伴在不影響實際運作系統的情況下測試 API 請求。
透過 Sandbox,您可以測試航班與住宿 API 的搜尋、空房狀況、預訂及取消功能。
什麼是「沙盒」?
The Sandbox 是一個基於 non-production 的模擬層,透過模擬回應來模擬真實 API 的行為。其目的是為了協助開發者:
- 驗證 API 結構與參數需求。
- 測試請求/回應流程。
- 在與生產環境整合之前,請先了解回應格式。
- 在受控環境中模擬常見的錯誤情況。
所有沙盒請求均應使用以下基礎 URL 和標頭:
curl https://apim.sandbox.expedia.com \
-H 'Authorization: ••••••'請參閱Basic-Authentication 以了解如何對您的請求進行驗證。
沙盒環境與生產環境之間的關鍵差異:
- 沙盒使用模擬資料,不會影響實際庫存
- 在沙盒環境中,某些功能可能會受到限制或僅為模擬
- 回應時間可能與正式版本有所不同
申請沙盒存取權限
所有沙盒端點皆 可透過與生產環境相同的 API 金鑰或憑證機制公開存取。
如何使用沙盒
我們的 API Explorer 提供便捷的 Try-It-Out 體驗,讓您無需撰寫任何程式碼,即可直接在瀏覽器中測試 Sandbox API。
請依照以下步驟開始操作:
- 開啟 API Explorer
前往Sandbox Playground 頁面。 - 請輸入驗證憑證
請在「基本驗證」區段中輸入您的使用者名稱及密碼。
請使用您在生產環境中使用的憑證,或專門用於存取沙盒環境的憑證。 - 選擇 API
請從可用清單中選擇您要測試的 API。 - 填寫參數
請使用本 Sandbox 指引文件中提供的範例值來填入請求參數。 - 點擊「試試看」
提交請求後,即可在「回應」區塊中查看模擬回應。 - 在 Postman 中使用 cURL 範例 (可選)
您也可以複製本文件中提供的 cURL 請求,並直接在 Postman、終端機或其他 REST 客戶端等工具中執行,以便在 API Explorer 介面之外進行測試。
可支援的 API
目前以下 API 支援 Sandbox 體驗:
住宿
| API 名稱 | 方法與終點 | 說明 |
|---|---|---|
| 刊登內容 | GET /hotels/listings | 返回模擬的搜尋結果 |
| 詳情 | GET /hotels/details | 返回模擬的庫存資料 |
| 預訂 | POST /hotels/bookings | 模擬預訂啟動流程 |
| 擷取 | GET /hotels/bookings | 返回一個範例預訂的模擬詳細資訊 |
| 取消 | PUT /hotels/bookings | 模擬預訂取消 |
| 取消詳情 | GET /hotels/bookings/canceldetails | 返回某筆示例預訂的模擬取消詳細資訊 |
機票
| API 名稱 | 方法與終點 | 說明 |
|---|---|---|
| 刊登內容 | GET /航班/列表 | 返回模擬航班的搜尋結果 |
| 詳情 | GET /航班/詳情 | 返回所選航班優惠的模擬可用性資料 |
| 預訂 | POST /flights/bookings | 模擬預訂啟動流程 |
| 擷取 | GET /航班/預訂 | 返回一個範例預訂的模擬詳細資訊 |
反應行為
這些模擬回應並非完全動態,亦非 data-driven. 改為:
- 部分 特定欄位 (例如 locationKeyword, ecomHotelIds 等) 可能會影響回應內容。
- 其他欄位僅為示範用途而設定為占位符或硬編碼。