快速活動 API 試點文檔
早期訪問預覽
本文檔是僅針對選定合作夥伴的早期存取預覽計畫的一部分。試點計畫將於 2025 年第三季啟動,並於 2026 年全面推出。
如果您有興趣成為試點或測試合作夥伴,請聯絡您的客戶經理。
最近的證據表明,旅行者越來越追求真實的體驗,而不是物質財富,雖然 pre-Covid 就是這種情況,但在 post-pandemic 世界中更是如此。快速活動 API 旨在幫助合作夥伴透過易於整合的 end-to-end 預訂路徑向其客戶展示活動和體驗。這使得客戶能夠獲得更全面的預訂體驗,並為合作夥伴開闢新的收入來源。
Rapid /activities API 套件
快速活動由一系列端點組成,這些端點共同實作 search-to-book 流。
由於該產品仍處於早期訪問階段,請記住架構細節和功能仍處於積極開發中,在向合作夥伴全面發布該產品之前可能會發生變化。
以下是涉及的主要終點:
操作 | 方法 | 剩餘 URI | 結果 |
---|---|---|---|
搜尋活動 | GET | /活動/可用性 | 根據給定的位置和日期範圍檢索可用的活動和體驗。 |
看詳情 | GET | /活動/{activity_id}/優惠 | 尋找選定活動的優惠。返回該特定活動的旅遊時間和價格等。 |
確認價格 | GET | /活動/{activity_id}/優惠/{offer_id} | 傳回總計價格和必需的預訂欄位。 |
註冊預訂的付款方式 | POST | /付款 | 預訂時註冊付款方式。回應將包括建立預訂請求正文中的 payment_token 。 |
建立預訂 | POST | /行程/活動 | 建立預訂。該端點將傳回一個帶有相關操作連結的itinerary_id 。 |
透過行程 ID 請求現有預訂的詳細信息 | GET | /行程/{itinerary_id}/活動 | 透過itinerary_id 參數返回行程詳情。 |
請活動供應商提供現有預訂的詳細資訊。 | GET | /行程/活動 | 根據 affiliate_reference 參數傳回預訂的詳細資訊。 |
取消預訂 | 刪除 | /行程/{itinerary_id}/活動 | 取消現有預訂。 |
用例
您可以使用以下方法使用快速活動 API 為您的客戶建立 end-to-end 預訂體驗。
步驟 1 - 搜尋所需地點的可用活動和體驗
使用 /activities/availability 端點,旅客可以查看其目的地逗留期間可進行哪些活動。
看看下面的關鍵參數:
關鍵參數 | 說明 | 建議 |
---|---|---|
start_date | 搜尋可用活動的開始日期。 | 使用 ISO 8601 格式。例如,2018-02-12。 |
end_date | 搜尋可用活動的結束日期。 | 使用 ISO 8601 格式。例如,2018-02-12。 |
currency | 請求的匯率貨幣。 | 使用 ISO 4217 格式。例如美元。 |
language | 所需的響應語言。 | 僅使用 ISO639-1 alpha 2 語言代碼和 ISO3166-1 alpha 2 國家/地區代碼。 |
country_code | 旅行者銷售點的國家代碼。 | 使用 ISO 3166-1 alpha-2 格式。這應該代表發生購物交易的國家/地區。例如美國。 |
region_id | 旅行者尋找活動的地點或區域。 | 例如,1122931。 |
limit | 響應中傳回的最大活動數。 | 最大值:100 |
步驟 2 - 獲取所需活動的可用優惠詳情
為客戶取得更多有關所選活動可享有哪些優惠的資訊。/activities/{activity_id}/offers 端點返回活動可用的旅遊等的時間和價格。
以下是旅客在預訂前需要了解的詳細資訊:
端點 | 用它來... |
---|---|
callouts | 在預訂之前向顧客提供有關活動的重要資訊。 |
inclusions | 概述活動所包含的所有功能。 |
exclusions | 提供活動未包含的功能清單。 |
步驟 3 - 確認價格並提供付款詳情
一旦您的客戶找到了完美的度假體驗,請使用 /activities/{activity_id}/offers/{offer_id> 端點來驗證當前價格和所需的預訂資訊。
步驟 4 - 從客戶那裡獲取有關其選擇的付款方式的信息
現在您可以使用 /payments 端點允許客戶註冊預訂的付款方式。回應將包含 payment_token
,它位於建立預訂請求的正文中。
步驟 5 - 建立預訂
使用 /itineraries/activity 端點建立預訂。該端點將傳回一個包含所有相關操作連結的itinerary_id
。
第 6 步 - 檢索預訂詳情
您可以使用 /itineraries/{itinerary_id}/activity 端點透過行程 ID 擷取預訂詳情。如果適用,回覆將包含取消連結。
API 詳細資料
探索此頁面上的 activity-related 端點定義,然後使用測試軟體來了解範例和模式定義與實際輸出的比較。當此 API 完成試點階段後,其端點也將包含在我們的 API Explorer 中。