快速活动 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 参数返回预订的详细信息。 |
取消预订 | DELETE | /行程/{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 中。