# 开发前必读
# 开发须知
| 序号 | 事项 | 操作说明 |
|---|---|---|
| 1 | 获取产品配置 appflag 等关键信息 | 联系阅文对接人确认合作产品已完成注册配置，然后获取 appflag 和 appsecret，配置 ip 白名单。参考：阅文开放平台接入指南 |
| 2 | 开发前必读 | 了解 API 功能列表、基本流程、稳定性说明 |
| 3 | 了解接口规范 | 了解接口规范、通用参数、通用返回值、错误码等 |
# API 功能列表简介
为了帮助合作方更快了解业务流程，本环节将介绍常见的业务信息。
| 序号 | API | 描述 |
|---|---|---|
| 1 | 获取全量书籍 ID 列表 | 该接口适用于合作方定时（建议 1 天 1 次）获取全量书籍 ID 列表。 |
| 2 | 获取书籍基本信息 | 该接口适用于合作方获取单本书籍基本信息（如简介、书籍名称等）。 |
| 3 | 获取书籍的所有章节列表 | 该接口适用于合作方获取书籍的所有章节列表。 |
| 4 | （免费模式）获取章节内容 | 该接口适用于免费合作模式下合作方用户实时获取书籍的单章内容。参考付费/免费模式 |
| 5 | （付费模式）获取章节内容 | 该接口适用于付费合作模式下合作方用户实时获取书籍的单章内容（如内容正文、是否付费章节、是否购买等）。如果没有购买，只返回预览正文。参考付费/免费模式 |
| 6 | （付费模式）批量获取章节列表 | 该接口适用于付费合作模式下合作方批量获取章节信息（如用户是否已购买，章节的折扣信息等）。参考付费/免费模式 |
| 7 | （付费模式）购买书籍或章节 | 该接口适用于付费合作模式下合作方用户实时购买付费章节或整本书。 |
| 8 | 获取指定时间内下架书籍 | 该接口适用于合作方定时（建议 10 分钟 1 次）获取最近时间段内下架的书籍 ID 列表。参考书籍更新/上架/下架规则 |
| 9 | 获取指定时间内更新与上架书籍 | 该接口适用于合作方定时（建议 10 分钟 1 次）获取最近时间段内更新与上架的书籍 ID 列表。参考书籍更新/上架/下架规则 |
| 10 | 获取 epub 书籍文件下载地址 | 该接口适用于合作方用户实时获取 epub 文件下载地址（含购买校验）。参考 epub 书规则 |
| 11 | 获取分类信息列表 | 该接口适用于合作方获取所有分类信息。 |
| 12 | 获取智能标签接口 | 该接口适用于合作方获取智能标签信息。 |
# 基本流程
1.合作方提前存储书籍信息（除章节内容外的信息）
| 步骤 | 说明 |
|---|---|
| 第一步：获取书籍 ID | 获取全量书籍 ID 列表 |
| 第二步：获取书籍基本信息 | 获取书籍基本信息，合作方存储信息 |
| 第三步：获取目录信息 | 获取书籍的所有章节列表，合作方存储信息 |
2.书籍更新/上架/更新流程（参考书籍更新/上架/下架规则）
3.用户阅读场景，合作方服务端实时调用阅文章节内容信息。 注意：获取章节内容必须传递 openid（合作方用户唯一表示标识）
- 免费合作：（免费模式）获取章节内容
- 付费合作：
- 购买章节：（付费模式）购买书籍或章节
- 章节内容： （付费模式）获取章节内容
- 如果付费章节没有购买，只返回预览正文内容
- 如果免费章节或已购买章节，返回完整正文内容
付费章节阅读流程参考：
# 稳定性说明
服务稳定性为 99.95%，内网平均耗时<400ms。公网耗时视接入方网络情况而定。如出现以下情况，会影响稳定性、耗时：
QPS 超过约定：默认单接口 QPS 为 100。如超过该 QPS，请在对接群里联系阅文商务申请调整。
合同中不可抗力场景：包括但不限于地震、台风、合规等。