快速活动 API 概述
通过 Rapid Activities API,让旅行者能够轻松预订活动和体验。
抢先体验版
本文档是仅面向特定合作伙伴的早期访问预览计划的一部分。试点项目将于 2026 年第二季度启动,并于 2027 年全面推出。
如果您有兴趣成为试点或测试合作伙伴,请联系您的客户经理。
Rapid Activities API 旨在帮助您通过易于集成的 end-to-end 购物和预订流程向旅行者展示活动。这可以为旅行者提供更全面的体验 ,同时也能帮助您开拓新的收入来源。
关键概念
- 活动: 可预订的活动(您展示和销售的内容)。
- **活动组:**一组类似的活动。
- 体验: 一个概念/营销包装,可能包含多种活动。
- 门票: 活动的门票类型(成人/儿童/婴儿等)。
- 行程安排: 包含一项活动和一张或多张门票的预订(活动预订)。
- 类别: High-level 将体验和活动分类到主题中的分组(例如,城市 之旅、博物馆或户外活动)。
- **属性:**描述性标志,用于捕捉体验或活动的特定特征(例如,轮椅无障碍、适合家庭、导览游或免排队)。
端到端集成流程
使用此 API 预订活动遵循以下一般流程。
第一步:发现库存
了解目的地可以销售的商品和服务,并按目的地创建结构化的活动目录,以便进行商品销售。
- 使用区域映射端点将 地理 API 区域映射到底层库存(体验、活动和活动组)。注意:在此版本中,Activities API 仅支持
region_ID参数。 - 提取多种语言的丰富活动内容(标题、描述、图像、地点和类别)。
- 收集宾客对活动的评分和评论,帮助旅行者比较各种选择,并建立对体验的信任。
- 填充搜索结果、活动详情页面和筛选条件( 例如,适合家庭或徒步旅行)。
第二步:查询库存和价格
了解各项活动的开展时间和价格。利用可预订日期/时间、票务选项和价格范围来推动购物体验。
- 如需了解具体活动和日期,请按票种查询空位情况和价格。
- 在购物体验中显示日历(可用/不可用日期)、时间段和起价。
- 支持在一次通话中执行多个操作。
步骤 3:Pre-booking 价格查询
付款前请确认最终预订价格并获取所需预订字段列表。收到与最新库存和政策相符的确认报价和预订凭证。
- 实时验证特定选择(活动、日期、时间和门票)。
- 获取最终价格、税费和供应情况(包括价格变动或售罄)。
- 获取有关所需预订字段(例如乘客详细信息或 pick-up 类型)和预订安全令牌的详细信息。
第四步:创建预订
将已确认的选择转换为预订。您将收到一份已确认的行程(预订),您可以在自己的系统中显示和管理该行程。
- 将购物流程中的预订令牌作为查询参数发送,将来自 Payments API 的
payment_token放在请求正文中,并附上旅行者详细信息(主要旅行者和附加旅行者)。 - 请添加您自己的联盟营销参考编号,以便您日后核对和搜索预订信息。
- 收到行程编号和用于检索预订详情的链接。
第五步:管理预订
支持客户和代理商的预订后工作流程。使用完整的预订后工具集,查看、取消现有预订并提供代金券。
- 通过行程 ID 或您的联盟参考号检索预订详情。
- 在允许的情况下取消预订,并将结果告知客户。
- 收集顾客在活动中需要出示的凭证文件。
测试错误响应
要向给定的 Rapid Activities API 方法发送测试请求,请在购物或预订请求中包含名为 test的附加 HTTP 标头,并使用下表中的相应值。未能发送测试标头或发送无效的测试标头将导致请求实时处理。
**注意:**使用测试标头将产生静态响应消息,因此返回的速率和内容可能与正在测试的活动无关。
购物和内容 API
| 测试标头值 | HTTP 代码和响应 | 状态 |
|---|---|---|
| 标准型车 | 200 OK(标准成功响应) | 成功 |
invalid_input | 400 错误请求(输入无效) | 错误 |
bad_link | 400 错误请求(无效链接) | 错误 |
internal_server_error | 500 内部服务器错误(未知错误) | 错误 |
service_unavailable | 503 服务不可用 | 错误 |
预订 API
| 测试标头值 | HTTP 代码和响应 | 状态 |
|---|---|---|
| 标准型车 | 200 OK(标准成功响应) | 成功 |
invalid_input | 400 错误请求(输入无效) | 错误 |
bad_link | 400 错误请求(无效链接) | 错误 |
price_mismatch | 409 冲突(价格不匹配) | 错误 |
sold_out | 409 冲突(已售罄) | 错误 |
internal_server_error | 500 内部服务器错误(未知错误) | 错误 |
service_unavailable | 503 服务不可用 | 错误 |
按用例划分的端点摘要
| 用例 | 方法和路径 | 必填查询参数/注释 |
|---|---|---|
| 地区经验 | GET /regions/{region_id}/experiences | language |
| 区域活动小组 | GET /regions/{region_id}/activity-groups | language |
| 区域活动 | GET /regions/{region_id}/activities | language |
| 体验内容 | GET /experiences/content | experience_id[]、language |
| 活动组内容 | GET /experiences/activity-groups/content | language、activity_group_id[] |
| 活动内容 | GET /experiences/activities/content | activity_id[]、language |
| 活动运营时间 | GET /experiences/activities/{activity_id}/operating-hours | start_date,end_date(≤ 90 天),language |
| 经验类别 | GET /experiences/categories | language、pagination_size |
| 经验属性 | GET /experiences/attributes | language、pagination_size |
| 活动类别 | GET /experiences/activities/categories | language、pagination_size |
| 活动属性 | GET /experiences/activities/attributes | language、pagination_size |
| 住客点评 | GET /experiences/activities/{activity_id}/guest-reviews | limit、sort |
| 供货情况和价格 | GET /experiences/activities/availability | activity_id[],start_date,end_date(≤14),currency,language |
| 房态日历 | GET /experiences/activities/calendars/availability | activity_id[],start_date,end_date |
| 价格检查 | GET /experiences/activities/{activity_id}/price-check | token (来自购物 API 调用) tickets |
| 创建预订 | POST /itineraries/activity | 询问: token(来自购物 API 调用) 身体: CreateItineraryRequest,affiliate_reference_id,payment_token,primary_traveler |
| 通过行程 ID 检索 | GET /itineraries/{itinerary_id}/activity | — |
| 通过关联引用检索 | GET /itineraries/activity | affiliate_reference_id |
| 取消预订 | DELETE /itineraries/{itinerary_id}/activity | 204(预订已成功取消)202(状态未知) |
| 取回凭证 | GET /itineraries/{itinerary_id}/activity/voucher | 返回链接以获取 已预订活动的凭证 |
**笔记:**后面跟着的参数[]表示 comma-separated 数组中可以有多个值。
API 详情
浏览此页面上的 activity-related 端点定义,然后使用 Postman 等测试软件来了解示例和模式定义与实际输出的比较情况。当此 API 完成试点阶段后,其端点也将包含在我们的 API Explorer 中。