快速活动 API 概述
通过 Rapid Activities API,让旅行者能够轻松预订活动和体验。
抢先体验版
本文档是仅面向特定合作伙伴的早期访问预览计划的一部分。Beta 测试计划将于 2026 年第三季度启动,并于 2027 年全面推出。
如果您有兴趣成为测试合作伙伴,请联系您的客户经理。
Rapid Activities API 旨在帮助您通过易于集成的 end-to-end 购物和预订流程向旅行者展示活动。这可以为旅行者提供更全面的体验,同时也能帮助您开拓新的收入来源。
关键概念
| 期限 | 定义 |
|---|---|
| 活动 | 可预订活动(您展示和销售的内容)。 |
| 活动组 | 一系列类似的活动。 |
| 体验 | 一个概念性/营销包装,可能包含多种活动。 |
| 门票 | 活动的预订类型(成人/儿童/婴儿等)。 |
| 行程 | 包含一项活动和一张或多张门票的预订(活动预订)。 |
| 类别 | High-level 将体验和活动按主题分类(例如,城市观光、博物馆或户外活动)。 |
| 属性 | 描述性标志,用于捕捉体验或活动的具体特征(例如,轮椅无障碍、“适合家庭”、“导览游”或“免排队”)。 |
端到端集成流程
使用此 API 预订活动遵循以下一般流程。
第一步:发现库存
首先,创建一个按目的地分类的结构化活动目录,以便进行商品销售。本目录将帮助您了解在该地区您可以销售哪些产品。
建立产品目录
- 使用 region-mapping 端点将地理区域映射到底层库存(体验、活动和活动组)。注意: 在此版本中,Activities API 仅支持
region_ID参数。
>> 查看更多关于区域的信息 2. 提取多种语言的丰富活动内容(标题、描述、图像、地点和类别)。 3. 收集宾客对活动的评分和评论,帮助旅行者比较各种选择,并建立对体验的信任。 4. 填充搜索结果、活动详情页面和筛选器(例如,“适合家庭”或“徒步旅行”)。
按地区和面积筛选
使用 Rapid Activities API,您可以使用 area 查询参数来筛选结果,以在由 region_id 和 area 坐标定义的区域的交集中进行发现。这样可以帮助您减少自定义筛选逻辑,并向旅客显示可能靠近特定地点(例如酒店)的活动。
要使用 area 过滤器,请在其中包含 radius_km、latitude 和 longitude 字段,以描述要返回的活动的地理范围。
示例请求
GET /v2/regions/{region_id}/activity-groups?area=10,34.0512226,-118.2403994&pagination_size=25注意: radius_km(area内的第一个字段)必须是大于或等于 0 的整数。
第二步:查询库存和价格
了解各项活动的开展时间和价格。利用可预订日期/时间、票务选项和价格范围来推动购物体验。
- 如需了解具体活动和日期,请按票种查询空位情况和价格。
- 在购物体验中显示日历(可用/不可用日期)、时间段和起价。
- 支持在一次通话中执行多个操作。
步骤 3:Pre-booking 价格查询
付款前请确认最终预订价格并获取所需预订字段列表。收到与最新库存和政策相符的确认报价和预订凭证。
- 实时验证特定选择(活动、日期、时间和门票)。
- 获取最终价格、税费和供应情况(包括价格变动或售罄)。
- 获取有关所需预订字段(例如乘客详细信息或 pick-up 类型)和预订安全令牌的详细信息。
第四步:创建预订
将已确认的选择转换为预订。您将收到一份已确认的行程(预订),您可以在自己的系统中显示和管理该行程。
- 将购物流程中的预订令牌作为查询参数发送,并将来自 Payments API 的
payment_token连同旅行者详细信息(主要旅行者和附加旅行者)一起发送到请求正文中。 - 请添加您自己的联盟营销参考编号,以便您日后核对和搜索预订信息。
- 收到行程编号和用于检索预订详情的链接。
第五步:管理预订
支持客户和代理商的预订后工作流程。使用完整的预订后工具集,查看、取消现有预订并提供代金券。
- 通过行程 ID 或您的联盟参考号检索预订详情。
- 在允许的情况下取消预订,并将结果告知客户。
- 收集顾客在活动中需要出示的凭证文件。
可退款价格
Rapid Activities API 支持按“可退款率”属性筛选活动,以表示在列出的取消期限内取消活动时可获得退款的活动。此功能旨在帮助减少对自定义筛选逻辑的需求,并向旅行者展示提供更灵活取消政策的活动。
筛选可退款活动
使用attribute_id属性 ID 为 25 的参数,用于表示可退款率。
GET /v2/regions/{region_id}/activities?attribute_id=25
**笔记:**在向旅客显示取消条款时,您应该继续使用回复中提供的政策信息。
示例请求
GET /experiences/activities/content?language=en-US&activity_id=703295&activity_id=973888&activity_id=975441&activity_id=1006352&supported_booking_data_types=*&attribute_id=25测试错误响应
要发送针对特定 Rapid Activities API 方法的测试请求,请包含一个名为“test”的附加 HTTP 标头。test在您的购物或预订请求中,并使用下表中的相应值。未能发送测试标头或发送无效的测试标头将导致请求实时处理。
**笔记:**使用测试标头将返回静态消息,因此返回的速率和内容可能与正在测试的活动无关。
购物和内容 API
| 测试标头值 | HTTP 代码和响应 | 状态 |
|---|---|---|
| 标准型车 | 200 OK(标准成功响应) | 成功 |
bad_link | 400 错误请求(无效链接) | 错误 |
invalid_input | 400 错误请求(输入无效) | 错误 |
internal_server_error | 500 内部服务器错误(未知错误) | 错误 |
service_unavailable | 503 服务不可用 | 错误 |
预订 API
| 测试标头值 | HTTP 代码和响应 | 状态 |
|---|---|---|
| 标准型车 | 200 OK(标准成功响应) | 成功 |
bad_link | 400 错误请求(无效链接) | 错误 |
invalid_input | 400 错误请求(输入无效) | 错误 |
price_mismatch | 409 冲突(价格不匹配) | 错误 |
sold_out | 410 冲突(已售罄) | 错误 |
internal_server_error | 500 内部服务器错误(未知错误) | 错误 |
service_unavailable | 503 服务不可用 | 错误 |
API 详情
浏览此页面上的 activity-related 端点定义,然后使用 Postman 等测试软件来了解示例和模式定义与实际输出的比较情况。当此 API 完成试点阶段后,其端点也将包含在我们的 API Explorer 中。