# 犀光小说对接文档
# 小说热门推荐接口
# 概述
根据用户点击,阅读和收藏次数统计小说热度进行推荐
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL : https://xiaojiding.com/HttpService/story/hot
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
from_sources | 小说来源 | 否 | 默认为所有来源,若为"qiyu",则只显示qiyu的小说 |
- 成功返回值: Json结构
{
"code": 0,
"msg": "succeed",
"total": 7,
"data": [ // 小说json结构列表
{
"novel_id": 23, //小说id, 每本小说的唯一性标识
"title": "我们不是商业CP吗", //小说名称
"author": "白媚娘", // 作者
// 简介
"abstract": "我们两家公司曾经是同一家公司。 我老板曾经和顾连城的老板同居。 我老板也曾经当众砸过顾连城老板的电脑。 顾连城的老板起诉过我老板,逼我老板赔了好几个亿。 如果你有任何一点cp常识,你就会知道,这是绝不可能复合的关系。 现在,我要和我对家麦麸了,怎么办,挺急的,在线等",
// 封面图
"thumbnail": "http://qiniu4.xiguangtech.com/201901/15421845347111710.png",
"category": "纯爱", // 分类
"is_finished": 1, // 是否完结:0:连载中; 1:完结
"shelf_time": "2018-11-14", // 上架时间
"star": 2 //收藏数量
},
{
"novel_id": 21,
"title": "18.5爱情故事",
"author": "八千桂酒",
"abstract": "娱乐圈十八线和十九线烂俗狗血无聊爱情故事书",
"thumbnail": "http://qiniu4.xiguangtech.com/201901/15465049776903329.png",
"category": "纯爱",
"is_finished": 1,
"shelf_time": "2018-12-26",
"star": 1
}...
]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 小说精品推荐接口
# 概述
根据用户收藏次数统计小说精品进行推荐
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL : https://xiaojiding.com/HttpService/story/excellent
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
page_num | 分页页码 | 否 | page_num从1开始,默认为1 |
page_size | 分页大小 | 否 | 每页显示数量,默认为10 |
from_sources | 小说来源 | 否 | 默认为所有来源,若为"qiyu",则只显示qiyu的小说 |
- 成功返回值: Json结构
{
"code": 0,
"msg": "succeed",
"log_id": "",
"total": 2, // 精品小说总量
"data": [
{
"novel_id": 23, //小说id, 唯一性标识
"title": "我们不是商业CP吗", //小说名称
"author": "白媚娘", // 作者
"abstract": "我们两家公司曾经是同一家公司...", //内容简介
"thumbnail": "http://qiniu4.xiguangtech.com/201901/15421845347111710.png", //封面图
"category": "纯爱", //类型
"is_finished": 1, // 是否完结:0:连载中,1:完本
"shelf_time": "2018-11-14", //上架时间
"star": 2 //收藏数量
},
{
"novel_id": 21,
"title": "18.5爱情故事",
"author": "八千桂酒",
"abstract": "娱乐圈十八线和十九线烂俗狗血无聊爱情故事书",
"thumbnail": "http://qiniu4.xiguangtech.com/201901/15465049776903329.png",
"category": "纯爱",
"is_finished": 1,
"shelf_time": "2018-12-26",
"star": 1
}
]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 小说简介接口
# 概述
对应小说的简介内容:作者,收藏数,简介,封面图片等
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL : https://xiaojiding.com/HttpService/story/info
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
novel_id | 小说id | 是 |
- 成功返回值: Json结构
{
"code": 0,
"msg": "succeed",
"log_id": "ew32213as",
"data": {
"novel_id": 16, // 小说id,唯一性标识
"title": "十年磨一贱", // 小说名称
"author": "邓先森", // 作者
"abstract": "签了一个超难伺候的艺人是什么感觉?...", // 简介
"thumbnail": "http://qiniu4.xiguangtech.com/201901/201707021307003335.png", // 封面图
"category": "纯爱", //类型
"is_finished": 1, //是否完结: 0:连载中,1:完本
"shelf_time": "2017-06-04", //上架时间
"star": 1, //收藏数量
"views": 0, // 阅读数量
"catelog": [ // 小数目录,章节列表
{
"chapter_id": 1, //章节id,唯一性标识
"title": "第1章" // 章节名称
},
{
"chapter_id": 800,
"title": "第2章"
},
...
]
}
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 小说章节内容接口
# 概述
小说对应的章节内容,阅读使用,如果参数不传chapter_id会根据历史行为返回用户阅读的历史章节,传chapter_id会获取指定章节内容
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL : https://xiaojiding.com/HttpService/story/detail
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
novel_id | 小说ID | 是 | |
user_id | 阅读用户ID | 是 | |
chapter_id | 小说章节ID | 否 | 不传返回历史最近一次阅读 |
- 成功返回值: Json结构
{
"code": 0,
"msg": "succeed",
"log_id": "ew32213as",
"data": [
{
"novel_id": 15, // 小说ID
"title": "第1章", // 章节名称
"content": "第1章 \r\n 托马斯作为一个alpha,乃A界之耻。\r\n 他是战斗力为负的渣渣,智商看上去也不高的样子...",
// 章节内容
"chapter_id": 1 // 章节ID,对应章节的唯一性标识
}
]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 用户对小说操作接口
# 概述
用户对小说的阅读行为,收藏,取消收藏;
阅读时需要:ac_type,novel_id,chapter_id,user_id
取消,收藏是需要:ac_type,novel_id,user_id
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法: POST
- URL : https://xiaojiding.com/HttpService/story/action
- 参数 :
body:
{ "ac_type": 1, // 操作类型:1:阅读, 2:收藏,3:取消收藏, 其他待定
"novel_id": 9, // 小说id
"user_id": 22, //用户id
"chapter_id": 2, // ac_type=1时需要阅读的章节id
"log_id": "weaew" //随机生成字符串
}
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
novel_id | 小说ID | 是 | |
user_id | 阅读用户ID | 是 | |
chapter_id | 小说章节ID | 否 | 不传返回历史最近一次阅读 |
ac_type | 操作类型 | 是 | 1:阅读, 2:收藏,3:取消收藏 |
- 成功返回值: Json结构
返回数据:
{
"code": 0,
"msg":"succeed"
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 小说章节查询接口
# 概述
查询指定小说的所有章节id和对应的章节名称
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法: GET
- URL : https://xiaojiding.com/HttpService/story/catalog
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
novel_id | 小说ID | 是 |
- 成功返回值: Json结构
{
"code": 0,
"msg": "succeed",
"log_id": "ew32213as",
"data": {
"novel_id": 15, // 小说ID,唯一性标识
"chapter_info": [ //章节列表
{
"chapter_id": 1, // 章节ID,章节唯一性标识
"title": "第1章" // 章节名称
},
...
]
}
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 用户收藏小说查询
# 概述
查询用户收藏的小说列表
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法: GET
- URL : https://xiaojiding.com/HttpService/story/collect
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
user_id | ID | 是 | 用户的唯一性标识 |
- 成功返回值: Json结构
{
"code": 0, //返回码,0正常返回, -1:出现异常结果
"msg": "succeed", //正常返回消息
"total": 3, // 收藏总数
"data": [ // 收藏列表
{
"novel_id": 407, //小说id,唯一性标识
"title": "我的前妻是极品", //小说名称
// 封面图
"thumbnail": "http://qiniu4.xiguangtech.com/201904/bdd0f0e6-5461-11e9-90dc-e82a44e2c020.jpg",
"chapter_id": 61, // 当前用户收藏小说阅读到的章节id
"chapter_name": "正文第六十一章 大结局" // 当前用户收藏小说阅读到的章节名称
},
{
"novel_id": 647,
"title": "染指缠绵:闪婚老公太危险",
"thumbnail": "http://qiniu4.xiguangtech.com/201908/5817c436-c2f6-11e9-82f1-00e04c485d5d.jpg",
"chapter_id": 72,
"chapter_name": "第72章 后浪推前浪"
}
]
}
失败返回:
```json
{"errno": -1, "errmsg": "some of the parameters are illegal"}
# 查询小说被指定用户订阅
# 概述
查询某个小说是不是被指定用户订阅
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法: GET
- URL : https://xiaojiding.com/HttpService/story/collect
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
user_id | 用户ID | 是 | |
novel_id | 小说ID | 是 |
- 成功返回值: Json结构
{
"code":0,
"msg":"succeed",
"status":0 // 0::表示未被订阅, 1表示已订阅
}
失败返回:
{"errno": -1, "errmsg": "some of the parameters are illegal"}
# 根据分类查询返回小说
# 概述:
根据小说类别名称、状态(已完结、连载中)、排序(最热、最新)查询返回
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法 : GET
- URL : https://xiaojiding.com/HttpService/story/classification
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
category | 类名 | 是 | 根据该类别名称查询,category=all 查所有 |
page_num | 分页页码 | 否 | page_num从1开始,默认为1 |
page_size | 分页大小 | 否 | 每页显示数量,默认为10 |
is_finished | 完结状态 | 是 | 0表示连载中、1表示已完结、2 表示查询所有 |
sort_type | 排序方式 | 是 | hot表示按热门排序、new表示按最新排序 |
- 成功返回值:Json结构
{
"code": 0,
"msg": "succeed",
"total": 10,
"data": [
{
"novel_id": 863,
"title": "一夜迷情:老公轻点爱",
"category": "总裁豪门",
"author": "若菡",
"abstract": " 新婚前夜,亲眼目睹了未婚夫许嘉良与闺蜜秦梦瑶的激情,一夜之间遭受了双重背叛。\r\n 为了报复,我跟他的上司一夜激情。\r\n 为了成为萧墨的女人,我设计怀上他的孩子,用肚子逼迫他娶我。\r\n成为豪门贵太,生活并没有我想象中那么如意。\r\n我想离婚,他却将我狠狠的压在身下,霸道的宣布着,“顾心安,你这辈子只能是我萧墨的女人,你想逃到哪里去?”\r\n",
"thumbnail": "http://qiniu4.xiguangtech.com/201908/7fd4232a-c2f6-11e9-82f1-00e04c485d5d.jpg",
"is_finished": 1,
"shelf_time": "2019-08-20",
"star": 1,
"views": 16
},
...
]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 根据小说名搜索小说
# 概述:
根据小说名称搜索到对应小说
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL:https://xiaojiding.com/HttpService/story/search
- 参数:
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
title | 小说名称 | 是 | 根据title搜索 |
- 成功返回值:Json结构
{
"code": 0,
"msg": "succeed",
"total": 1,
"data": [{
"novel_id": 96,
"title": "山海镇 ", //小说名称
"category": "悬疑灵异", //分类
"author": "闹腾自己", //作者
"abstract": "来路不明的人,突然变异的龙虾,未知的生物,突然失踪的情侣。。。互不相关毫无逻辑的出现的事件,到底是神秘启示还是令人恐惧的罪恶?悬疑惊悚不重口,希望你喜欢,祝阅读故事愉快~", //简介
"thumbnail": "http://qiniu4.xiguangtech.com/201903/897dc7c6-4fd0-11e9-8de5-e82a44e2c020.jpg",
"is_finished": 1,
"shelf_time": "2019-03-27",
"star": 0
}]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}
# 获取所有分类名称
# 概述:
获取所有的小说类别名称
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法:GET
- URL:https://xiaojiding.com/HttpService/story/category
- 参数:
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
1.成功返回值:Json结构
{
"code": 0,
"msg": "succeed",
"total": 34,
"categories": [
"ABO爱情",
"纯爱",
"奇幻玄幻",
"武侠仙侠",
"都市娱乐",
"科幻游戏",
"悬疑灵异",
"二次元",
"历史军事",
"评论文集",
"竞技同人",
"都市言情",
"纯爱同人",
"短篇美文",
"古代言情",
"幻想时空",
"总裁豪门",
"青春校园",
"现代言情",
"同人作品",
"宫斗宅斗",
"穿越架空",
"种田经商",
"灵异鬼夫",
"仙侠修真",
"幻想言情",
"民国小说",
"浪漫青春",
"短篇精品",
"玄幻女强",
"都市生活",
"现言短篇",
"玄幻修真",
"传统历史"
]
}
{"errno": -1, "errmsg": "Existing parameters are not uploaded!"}
# 用户阅读历史记录
# 概述
用户对小说的阅读历史;
需要:app_id,user_i
# 注意事项:
数据编码必须是utf-8
# 接口说明:
- 方法: GET
- URL : https://xiaojiding.com/HttpService/story/user_read?app_id=default&user_id=ea2a792b03da801f517e66b281610785&pageno=0&size=6&log_id=adfads
- 参数 :
参数名 | 参数说明 | 是否必须 | 备注 |
---|---|---|---|
log_id | 日志标识 | 是 | 记录请求对应日志 |
app_id | 第三方APPID | 否 | |
user_id | 阅读用户ID | 是 | |
pageno | 页码 | 否 | 默认值0,页码从零开始 |
size | 条数 | 否 | 默认值5 |
- 成功返回值: Json结构
返回数据:
{
"code": 0,
"msg": "succeed",
"total": 2,
"data": [
{
"novel_id": 407, // 小说id
"chapter_id": 2, // 用户最后阅读章节id
"update_time": "2020-03-02 12:57:01", // 用户最后阅读时间
// 封面图
"thumbnail": "http://qiniu4.xiguangtech.com/201904/bdd0f0e6-5461-11e9-90dc-e82a44e2c020.jpg",
"title": "我的前妻是极品", // 小说名
"total_chapters": 61, // 总章节数
"chapter_name": "正文第二章 跑不掉的" // 用户最后阅读章节名称
}
]
}
失败返回:
{
"errno": -1,
"errmsg": "Existing parameters are not uploaded!"
}