火花全文接口API

注意事项

• 所有API接口的域名前缀：http://gateway--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/openx/
• 所有接口未显性指明申请JWT的方式，统一为用户名+密码的方式
• 所有接口统一认证方式：Header请求头中添加Authorization字段，值为"Bearer " +JWT

用户关注关键词

接口地址:/sparkling/theme/keywords

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:如果是在主题列表页取消关注的话，需要传父节点的navCode

请求示例:

{
    "careKeyword": "技术创新",
    "category": 1,
    "navCode": "0202",
    "subjectCode": "F099;F100;F101;F103;F104;F099"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
param	param	body	true	CareKeywordParam	CareKeywordParam
careKeyword	关注的主题词		false	string
category	关注类别，1表示关注。 0表示取消关注		false	integer(int32)
navCode			true	string
subjectCode	学科代码		false	string
accesstoken	令牌	header	false	string
Authorization	请求ID	header	false	string
Content-Type	内容类型	header	false	string
userId	userId	body	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	boolean
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": true,
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

关键词学科列表

接口地址:/sparkling/theme/subjects

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取关键词学科列表

请求参数:无

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	array	学科列表视图
children	子集	array	学科列表视图
level		integer(int32)
navCode	学科标识，用于前端业务展示	string
subjectCode	学科代码	string
subjectName	学科名称	string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": [
        {
            "subjectName": "哲学",
            "subjectCode": null,
            "level": 1,
            "navCode": "01",
            "children": [
                {
                    "subjectName": "哲学",
                    "subjectCode": "F099;F100;F101;F103;F104;F099",
                    "level": 2,
                    "navCode": "0101",
                    "children": null
                },
                {
                    "subjectName": "应用伦理*",
                    "subjectCode": "F101",
                    "level": 2,
                    "navCode": "0151",
                    "children": null
                }
            ]
        },
        {
            "subjectName": "经济学",
            "subjectCode": null,
            "level": 1,
            "navCode": "02",
            "children": [
                {
                    "subjectName": "理论经济学",
                    "subjectCode": "J146;J147",
                    "level": 2,
                    "navCode": "0201",
                    "children": null
                },
                {
                    "subjectName": "应用经济学",
                    "subjectCode": "J145;J146;J147;J158;J159;J157;H123;G112",
                    "level": 2,
                    "navCode": "0202",
                    "children": null
                },
                {
                    "subjectName": "金融",
                    "subjectCode": "J159",
                    "level": 2,
                    "navCode": "0251",
                    "children": null
                },
                {
                    "subjectName": "应用统计",
                    "subjectCode": "J148",
                    "level": 2,
                    "navCode": "0252",
                    "children": null
                },
                {
                    "subjectName": "税务",
                    "subjectCode": "J158",
                    "level": 2,
                    "navCode": "0253",
                    "children": null
                },
                {
                    "subjectName": "国际商务",
                    "subjectCode": "J157",
                    "level": 2,
                    "navCode": "0254",
                    "children": null
                },
                {
                    "subjectName": "保险",
                    "subjectCode": "J161",
                    "level": 2,
                    "navCode": "0255",
                    "children": null
                },
                {
                    "subjectName": "资产评估",
                    "subjectCode": "J152",
                    "level": 2,
                    "navCode": "0256",
                    "children": null
                },
                {
                    "subjectName": "数字经济",
                    "subjectCode": "J155",
                    "level": 2,
                    "navCode": "0258",
                    "children": null
                }
            ]
        }
        
    ],
    "count": null,
    "total": null,
    "code": 200
}

主题推送部分关键词学科列表

接口地址:/sparkling/theme/theme/keywords

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:主题推送部分关键词学科列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
keyword	主题检索	query	false	string
userId	userId	query	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	array	学科列表视图
children	子集	array	学科列表视图
level		integer(int32)
navCode	学科标识，用于前端业务展示	string
subjectCode	学科代码	string
subjectName	学科名称	string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": [
		{
			"children": [
				{
					"children": [
						{}
					],
					"level": 0,
					"navCode": "",
					"subjectCode": "",
					"subjectName": ""
				}
			],
			"level": 0,
			"navCode": "",
			"subjectCode": "",
			"subjectName": ""
		}
	],
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

主题词图表接口

接口地址:/sparkling/theme/theme/wordchart

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:主题词图表接口

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
navCode	navCode	query	true	string
subjectCode	学科代码	query	false	string
userId	userId	query	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	ThemeWordChartVo	ThemeWordChartVo
links	关键词关系信息	array	KeywordRela
nums	数量	integer
source	源	string
target	目标	string
themeKeywordInfo	主题词信息	array	ThemeKeywordInfo
category	类别。 0表示未被用户关注。 1表示已被用户关注	integer
id		string
keywordName	主题词名称	string
navCode	学科编码	string
showTimes	出现次数	integer
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"links": [
			{
				"nums": 0,
				"source": "",
				"target": ""
			}
		],
		"themeKeywordInfo": [
			{
				"category": 0,
				"id": "",
				"keywordName": "",
				"navCode": "",
				"showTimes": 0
			}
		]
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

星级好文列表（主题推送版）

接口地址:/sparkling/article/goods

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:星级好文列表（主题推送版）

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
careKeyword	关注的关键词	query	false	string
careKeywordList		query	false	array	string
keyword	检索关键词	query	false	string
level	等级，主要解决点击主题词二级的时候，显示所有匹配的数据，可以不传，默认为3级关键词。（目前仅支持到二级关键词）	query	false	integer(int32)
listType	榜单类型：1：总榜；2：周榜；3：月榜；4：年榜	query	false	integer(int32)
navCode	学科编码	query	false	string
pageIndex	页码	query	false	integer(int32)
pageSize	页大小	query	false	integer(int32)
subjectCode	学科代码	query	false	string
userId	userId	query	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	array	星级好文列表
articleAbstract	文章摘要	string
author	作者	string
authorCode	作者Code	array	string
authorList	作者列表	array	string
citedTimes	被引频次	integer(int32)
collectStatus	是否收藏文献	boolean
corePubInfo	核心期刊信息	array	string
corePubStatus	是否是核心期刊	boolean
dbCode	库代码	string
fileCode	文献代码	string
fileSourceType	文献来源，区分属于cnki文献还是用户上传文献	integer(int32)
fileType	文献类型，标识是xml还是pdf阅读	string
markNumber	标记人数	integer(int32)
pubDate	发表时间	string
readType	文献类型，期刊/博士 等	string
readUrl		string
source	文献来源	string
sourceCode	来源code	array	string
sourceList	来源列表	array	string
starRating	星级	integer(int32)
tableName	表名	string
title	文献标题	string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": [
		{
			"articleAbstract": "",
			"author": "",
			"authorCode": [],
			"authorList": [],
			"citedTimes": 0,
			"collectStatus": true,
			"corePubInfo": [],
			"corePubStatus": true,
			"dbCode": "",
			"fileCode": "",
			"fileSourceType": 0,
			"fileType": "",
			"markNumber": 0,
			"pubDate": "",
			"readType": "",
			"readUrl": "",
			"source": "",
			"sourceCode": [],
			"sourceList": [],
			"starRating": 0,
			"tableName": "",
			"title": ""
		}
	],
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

热门星级好文列表

接口地址:/sparkling/article/hots

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:热门星级好文列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
listType	榜单类型：1：总榜；2：周榜；3：月榜；4：年榜	query	true	integer(int32)

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	array	星级好文列表
articleAbstract	文章摘要	string
author	作者	string
authorCode	作者Code	array	string
authorList	作者列表	array	string
citedTimes	被引频次	integer(int32)
collectStatus	是否收藏文献	boolean
corePubInfo	核心期刊信息	array	string
corePubStatus	是否是核心期刊	boolean
dbCode	库代码	string
fileCode	文献代码	string
fileSourceType	文献来源，区分属于cnki文献还是用户上传文献	integer(int32)
fileType	文献类型，标识是xml还是pdf阅读	string
markNumber	标记人数	integer(int32)
pubDate	发表时间	string
readType	文献类型，期刊/博士 等	string
readUrl		string
source	文献来源	string
sourceCode	来源code	array	string
sourceList	来源列表	array	string
starRating	星级	integer(int32)
tableName	表名	string
title	文献标题	string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": [
		{
			"articleAbstract": "",
			"author": "",
			"authorCode": [],
			"authorList": [],
			"citedTimes": 0,
			"collectStatus": true,
			"corePubInfo": [],
			"corePubStatus": true,
			"dbCode": "",
			"fileCode": "",
			"fileSourceType": 0,
			"fileType": "",
			"markNumber": 0,
			"pubDate": "",
			"readType": "",
			"readUrl": "",
			"source": "",
			"sourceCode": [],
			"sourceList": [],
			"starRating": 0,
			"tableName": "",
			"title": ""
		}
	],
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

火花段落列表(主题词版本)

接口地址:/sparkling/section/sections

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:火花段落列表(主题词版本)

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
careKeyword	关注的关键词	query	false	string
careKeywordList		query	false	array	string
keyword	检索关键词	query	false	string
level	等级，主要解决点击主题词二级的时候，显示所有匹配的数据，可以不传，默认为3级关键词。（目前仅支持到二级关键词）	query	false	integer(int32)
listType	榜单类型：1：总榜；2：周榜；3：月榜；4：年榜	query	false	integer(int32)
navCode	学科编码	query	false	string
pageIndex	页码	query	false	integer(int32)
pageSize	页大小	query	false	integer(int32)
subjectCode	学科代码	query	false	string
userId	userId	query	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	SparkSectionVo	SparkSectionVo
likeCol	点赞集合	array	string
sectionListVo	段落集合列表	array	SectionListVo
author	作者	string
authorCode	作者Code	array	string
authorList	作者列表	array	string
dbCode	库代码	string
fileCode	文件名	string
fileSourceType	文献类型	integer
fileType	文献类型，标识是xml还是pdf阅读	string
likeCount	点赞总数	integer
likeStatus	是否点赞，0表示没有，1表示有	integer
notePersonCount	笔记人数	integer
noteTimes	笔记次数	integer
pageViews	浏览量	integer
paragraphId	段落id	string
pubDate	发表时间	string
readUrl	阅读地址	string
sectionContent	段落内容	string
source	文献来源	string
sourceCode	来源code	array	string
sourceList	来源列表	array	string
sparkLevel	火花等级	integer
tableName	表名	string
title	标题	string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"likeCol": [],
		"sectionListVo": [
			{
				"author": "",
				"authorCode": [],
				"authorList": [],
				"dbCode": "",
				"fileCode": "",
				"fileSourceType": 0,
				"fileType": "",
				"likeCount": 0,
				"likeStatus": 0,
				"notePersonCount": 0,
				"noteTimes": 0,
				"pageViews": 0,
				"paragraphId": "",
				"pubDate": "",
				"readUrl": "",
				"sectionContent": "",
				"source": "",
				"sourceCode": [],
				"sourceList": [],
				"sparkLevel": 0,
				"tableName": "",
				"title": ""
			}
		]
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

火花全文首页推荐

接口地址:/sparkling/home/recommended

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:火花全文首页推荐

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	false	string

响应状态:

状态码	说明
200	OK
418001	参数缺失
418002	参数无效
418005	Token缺失
418500	系统服务异常

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	HomeRecommendedVo	HomeRecommendedVo
articleList	文献列表	array	星级好文列表
articleAbstract	文章摘要	string
author	作者	string
authorCode	作者Code	array	string
authorList	作者列表	array	string
citedTimes	被引频次	integer
collectStatus	是否收藏文献	boolean
corePubInfo	核心期刊信息	array	string
corePubStatus	是否是核心期刊	boolean
dbCode	库代码	string
fileCode	文献代码	string
fileSourceType	文献来源，区分属于cnki文献还是用户上传文献	integer
fileType	文献类型，标识是xml还是pdf阅读	string
markNumber	标记人数	integer
pubDate	发表时间	string
readType	文献类型，期刊/博士 等	string
readUrl		string
source	文献来源	string
sourceCode	来源code	array	string
sourceList	来源列表	array	string
starRating	星级	integer
tableName	表名	string
title	文献标题	string
sparkSectionVo	段落信息	SparkSectionVo	SparkSectionVo
likeCol	点赞集合	array	string
sectionListVo	段落集合列表	array	SectionListVo
author	作者	string
authorCode	作者Code	array	string
authorList	作者列表	array	string
dbCode	库代码	string
fileCode	文件名	string
fileSourceType	文献类型	integer
fileType	文献类型，标识是xml还是pdf阅读	string
likeCount	点赞总数	integer
likeStatus	是否点赞，0表示没有，1表示有	integer
notePersonCount	笔记人数	integer
noteTimes	笔记次数	integer
pageViews	浏览量	integer
paragraphId	段落id	string
pubDate	发表时间	string
readUrl	阅读地址	string
sectionContent	段落内容	string
source	文献来源	string
sourceCode	来源code	array	string
sourceList	来源列表	array	string
sparkLevel	火花等级	integer
tableName	表名	string
title	标题	string
status	状态，false表示没有推荐数据，true表示有推荐数据	boolean
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"articleList": [
			{
				"articleAbstract": "",
				"author": "",
				"authorCode": [],
				"authorList": [],
				"citedTimes": 0,
				"collectStatus": true,
				"corePubInfo": [],
				"corePubStatus": true,
				"dbCode": "",
				"fileCode": "",
				"fileSourceType": 0,
				"fileType": "",
				"markNumber": 0,
				"pubDate": "",
				"readType": "",
				"readUrl": "",
				"source": "",
				"sourceCode": [],
				"sourceList": [],
				"starRating": 0,
				"tableName": "",
				"title": ""
			}
		],
		"sparkSectionVo": {
			"likeCol": [],
			"sectionListVo": [
				{
					"author": "",
					"authorCode": [],
					"authorList": [],
					"dbCode": "",
					"fileCode": "",
					"fileSourceType": 0,
					"fileType": "",
					"likeCount": 0,
					"likeStatus": 0,
					"notePersonCount": 0,
					"noteTimes": 0,
					"pageViews": 0,
					"paragraphId": "",
					"pubDate": "",
					"readUrl": "",
					"sectionContent": "",
					"source": "",
					"sourceCode": [],
					"sourceList": [],
					"sparkLevel": 0,
					"tableName": "",
					"title": ""
				}
			]
		},
		"status": true
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}