开发前必读

开发须知

序号	事项	操作说明
1	获取产品 appKey 等关键信息	联系阅文对接人确认合作产品已完成注册配置，然后获取 appKey，配置 ip 白名单。参考：阅文开放平台接入指南
2	开发前必读	了解 API 功能列表、基本流程、稳定性说明
3	了解接口规范	了解接口规范、通用参数、通用返回值、错误码等

API 功能列表简介

为了帮助合作方更快了解业务流程，本环节将介绍常见的业务信息。

序号	API	描述
1	获取全量书籍 ID 列表	该接口适用于合作方定时（建议 1 天 1 次）获取全量书籍 ID 列表。
2	获取书籍基本信息	该接口适用于合作方获取单本书籍基本信息（如简介、书籍名称、书籍的付费或免费等）。查看书籍付费/免费规则
3	获取书籍的卷列表	该接口适用于合作方获取单本书籍卷列表信息。查看目录结构说明
4	获取书籍单卷的章节列表	该接口适用于合作方获取书籍单卷的章节列表信息。参考目录结构说明
5	获取书籍的所有章节列表	该接口适用于合作方获取书籍的所有章节列表（目录结构中无卷结构）。参考目录结构说明
6	获取书籍章节内容	该接口适用于合作方获取书籍的单章内容。
7	获取指定时间内下架书籍	该接口适用于合作方定时（建议 10 分钟 1 次）获取最近时间段内下架的书籍 ID 列表。参考书籍更新/上架/下架规则
8	获取指定时间内更新与上架书籍	该接口适用于合作方定时（建议 10 分钟 1 次）获取最近时间段内更新与上架的书籍 ID 列表。参考书籍更新/上架/下架规则
9	获取 epub 书籍文件下载地址	该接口适用于合作方获取 epub 书文件下载地址（具有时效性，请及时获取下载内容存储）。参考 epub 书规则
10	获取分类信息列表	该接口适用于合作方获取所有分类信息。
11	获取智能标签	该接口适用于合作方获取智能标签信息。
12	消费订单回传	该接口适用于合作方回传用户消费订单数据。
13	充值订单回传	该接口适用于合作方回传用户充值订单数据。
14	阅读时长回传	该接口适用于合作方回传用户阅读时长数据。

基本流程

获取全量书籍，合作方存储数据（书籍基本信息、书籍目录信息、书籍章节内容等）。

步骤	说明
第一步：获取书籍 ID 列表	获取全量书籍 ID 列表。
第二步：获取书籍基本信息	获取书籍基本信息，合作方存储书籍基本信息。
第三步：获取目录信息	包含卷的目录结构  1.获取书籍的卷列表，合作方存储信息。  2.获取书籍单卷的章节列表，合作方存储信息。 不包含卷的目录结构  1. 获取书籍的所有章节列表，合作方存储信息。
第四步：获取章节内容	获取书籍章节内容，合作方存储信息。

其他流程（参考书籍更新/上架/下架规则）

稳定性说明

服务稳定性为 99.95%，内网平均耗时<400ms。公网耗时视接入方网络情况而定。如出现以下情况，会影响稳定性、耗时：

• QPS 超过约定：默认单接口 QPS 为 100。如超过该 QPS，请在对接群里联系阅文商务申请调整。

• 合同中不可抗力场景：包括但不限于地震、台风、合规等。