千夜网 · 公网文档 · 集成与对接
研学 + 教育 · API 对接(骨架)
本页定义研学业务的接口边界:知识点/路线/任务模板、用户进度与线下数据回传。具体字段以最终 OpenAPI 为准。
API 接口定义
核心接口
GET /api/v1/tour/study/subjects获取学科列表GET /api/v1/tour/study/knowledge-points按学科/学段/版本获取知识点GET /api/v1/tour/study/paths按景区/学段/主题/时长获取研学路线GET /api/v1/tour/study/paths/{id}获取路线详情(含 POI 顺序)POST /api/v1/tour/study/progress/events事件流回传(幂等)GET /api/v1/tour/study/progress/summary用户视角汇总POST /api/v1/tour/study/reflections复盘提交
复用接口
/api/v1/explain/*个性化讲解,研学任务可把“讲解完成/互动问答”作为完成条件/api/v1/vision/*拍照识别,用于研学中的观察任务
离线补传与幂等设计
事件流回传
POST /api/v1/tour/study/progress/events
{
"idempotency_key": "uuid",
"occurred_at": "2026-04-10T12:00:00Z",
"event_type": "CHECKIN|LEARN|UPLOAD|REFLECTION",
"path_id": 1001,
"poi_id": 101,
"payload": { "note": "..." }
}
幂等设计
- 服务端按
idempotency_key去重 - 客户端生成唯一 UUID 作为幂等键
- 支持批量回传,减少网络请求
- 回传失败时自动重试,网络恢复后继续
离线缓存策略
- 端上使用本地存储缓存事件流
- 网络恢复后自动触发补传
- 补传成功后清理本地缓存
- 定期检查未补传的事件
教材版本与内容来源
知识点需记录课标/教材版本与来源。涉及教材/教辅内容时需评审版权与引用范围;建议把“结构化知识点与任务模板”作为主资产,正文材料走引用或自研内容。