# 业务规则说明
# 书籍付费/免费规则
说明：根据此规则，合作方可判断一本书给用户阅读的方式。
| 书籍类型 | 含义说明 |
|---|---|
| 付费书 | 用户阅读付费章节需要购买，免费章节免费阅读 |
| 免费书 | 用户免费阅读 |
| 包月书 | 用户需要有会员/月卡身份才可免费阅读 |
具体流程如下：
1）判断书籍类型：获取书籍基本信息的返回值 payStatus 判断。 注意：当一本书同时符合多种书籍类型，合作方可自选择书籍类型。
| payStatus | 说明 |
|---|---|
| 1 | 支持包月 |
| 2 | 支持免费模式 |
| 3 | 支持包月+免费 |
| 4 | 支持付费模式 |
| 5 | 支持付费+包月 |
| 6 | 支持免费+付费 |
| 7 | 支持付费+免费+包月 |
2）判断付费书的付费章节：根据章节信息的返回值 payFlag 判断。
| payFlag | 说明 |
|---|---|
| 1 | 本章收费 |
| -1 | 本章免费 |
# epub 书规则
说明：如果合作中有 epub 格式的书籍，需要根据以下流程进行书信息与内容的获取。
| epub 书获取步骤 | 说明 |
|---|---|
| 第一步：判断 epub 书 | 获取书籍基本信息返回数据中的 fileFormat 字段判断是否为 epub 书。 |
| 第二步：获取 epub 书籍内容 | 获取 epub 书籍文件下载地址（下载地址具有时效性），并通过下载地址获取 epub 书籍内容。 |
# 目录结构说明
说明：书籍目录结构分为包含卷的目录与不包含卷的目录，合作方可自行选择目录结构（建议选择包含卷的结构）。
| 目录结构类型 | 结构说明 | API 调用说明 | 参考图 |
|---|---|---|---|
| 包含卷的目录结构 | 一本书有多卷，一卷有多章节。 （书->卷->章） | 1. 获取书籍的卷列表 2.获取书籍单卷的章节列表 | |
| 不包含卷的目录结构 | 一本书多章（书->章） | 获取书籍的所有章节列表 |
# 书籍更新/上架/下架流程
说明：书籍信息会发生变化，因此合作方需要获取最近更新与上架、下架的书籍 ID，然后更新/新增/删除对应的书籍信息。
书籍上架/更新流程 注意：返回值是 url 地址的，需要重新获取 url 内容进行新增或更新。
| 步骤 | 说明 |
|---|---|
| 第一步：定时获取近期更新与上架的书籍 ID 列表 | （建议每 10 分钟一次）获取指定时间内更新与上架书籍 ID 列表 |
| 第二步：获取最新书籍基本信息 | 获取书籍基本信息，合作方替换存储信息。 |
| 第三步: 获取最新目录信息 | 包含卷的目录结构 1.获取书籍的卷列表，合作方替换存储信息。 2.获取书籍单卷的章节列表，合作方替换存储信息。 不包含卷的目录结构 1. 获取书籍的所有章节列表，合作方替换存储信息。 |
| 第四步：获取章节内容 | 章节内容更新场景：根据章节信息中的 content_md5 字段判断是否需要更新，如果需要更新，获取书籍章节内容，合作方替换存储信息。 新增章节内容场景：获取书籍章节内容，合作方存储信息。 |
书籍下架流程：
| 步骤 | 说明 |
|---|---|
| 第一步：定时获取近期下架的书籍 ID 列表 | （建议每 10 分钟一次）获取指定时间内下架书籍 ID 列表 |
| 第二步：合作方下架书籍 | 请合作方下架对应书籍，并删除已经存储下架书籍的所有信息， |