Google IOWeb2015 项目API接口详解

项目概述

Google IOWeb2015 是一个为Google I/O 2015开发者大会设计的Web应用程序后端API系统。它为前端应用提供了完整的接口支持，包括用户认证、日程管理、通知推送等功能模块。

认证机制

认证流程详解

系统采用基于Bearer Token的认证方式，所有需要认证的接口都要求在请求头中包含：

Authorization: Bearer <ID或访问令牌>

认证流程采用Google Sign-In 2.0的混合服务器端流程。当用户完成前端登录后，前端需要向以下端点发起请求完成认证：

POST /api/v1/auth
Authorization: Bearer <ID或访问令牌>
Content-Type: application/json

{"code": "从混合服务器端流程获取的一次性授权码"}

认证错误处理

• 非200状态码：客户端应注销用户并尝试重新认证（"lite re-signin"）
• 498状态码：特殊错误码，表示客户端应撤销所有令牌并从头开始重新认证

响应处理规范

所有API端点都使用application/json作为请求和响应的MIME类型。

成功响应

• 状态码：2XX
• 可能包含响应体（根据具体方法说明）

错误响应

• 状态码：4XX或更高
• 可能包含错误描述：

{"error": "错误描述信息"}

V1 API接口详解

1. 社交媒体数据

端点：GET /api/v1/social

获取带有#io15标签的@googledevs推文。响应示例展示了推文的基本信息，包括作者、内容、发布时间等。

2. I/O扩展活动

端点：GET /api/v1/extended

获取全球各地的I/O Extended活动信息，包括活动名称、地点、经纬度坐标等。这些数据可用于在地图上展示活动分布。

3. 活动日程

端点：GET /api/v1/schedule

获取完整的大会议程安排。开发者可以获取所有会议场次、时间、地点等详细信息。

4. 用户通知管理

获取通知状态

端点：GET /api/v1/user/notify (需认证)

返回用户当前的通知设置状态，包括：

• 全局通知开关
• 订阅者列表
• I/O开始提醒
• I/O扩展活动位置提醒

更新通知设置

端点：PUT /api/v1/user/notify (需认证)

允许用户配置多种通知选项：

• 全局通知开关
• 添加推送订阅
• I/O开始提醒（提前1天）
• 会议开始提醒（提前10分钟）
• I/O扩展活动位置提醒（80公里范围内）

5. 用户更新信息

端点：GET /api/v1/user/updates (需认证)

获取用户的个性化更新信息，包括：

• 会议更新（详情变更、视频添加、即将开始等）
• 新视频（包括非会议相关视频）
• 新的I/O扩展活动地点
• 用于下次请求的令牌

6. 用户日程管理

获取书签会议

端点：GET /api/v1/user/schedule (需认证)

返回用户收藏的会议ID列表。

添加会议到书签

端点：PUT /api/v1/user/schedule/:session_id (需认证)

支持单次会议添加或批量添加。

从书签移除会议

端点：DELETE /api/v1/user/schedule/:session_id (需认证)

支持单次会议移除或批量移除。

7. 会议反馈调查

获取已提交反馈

端点：GET /api/v1/user/survey (需认证)

返回用户已提交反馈的会议ID列表。

提交会议反馈

端点：PUT /api/v1/user/survey/:session_id (需认证)

允许用户提交对会议的评分（1-5分）和文字评价。

V2 API接口改进

V2版本主要对通知管理接口进行了优化：

通知管理改进

端点：GET /api/v2/user/notify 和 PUT /api/v2/user/notify

主要变化：

• 使用endpoints数组替代了subscribers列表
• 简化了推送订阅管理
• 改进了registration_id的处理逻辑

技术要点总结

1. 认证安全：采用标准的Bearer Token认证，结合Google Sign-In流程，确保用户身份安全。

2. 通知系统：实现了灵活的通知配置，支持多种触发条件和推送方式。

3. 数据同步：通过/updates端点实现了高效的数据增量更新机制。

4. 批量操作：支持会议书签的批量添加和删除，提高操作效率。

5. 错误处理：设计了清晰的错误码体系，特别是498状态码的特殊处理逻辑。

这个API系统为Google I/O 2015的Web应用提供了完整的后端支持，涵盖了从用户认证到个性化内容管理的各个方面，体现了Google在开发者工具设计上的专业性和用户体验的重视。