知网研学开放平台文档

# 文献相关接口API

注意事项

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

# 检查转换状态

接口地址:/psmc/file/document/check

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:检查转换状态

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
taskId taskId query true integer(int32)

响应状态:

状态码 说明
200 OK
404001 系统异常
404011 参数缺失
404401 参数校验失败
404402 接口权益异常
404406 会员权限不足
404500 参数错误

响应参数:

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

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": "done",
    "count": null,
    "total": null,
    "code": 200
}

# 获取标引状态

接口地址:/psmc/file/mark/status

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述​：​-1:标引失败，1:标引成功，0:处理中， 10：元数据提取成功，15：无图碎片化成功，20：有图碎片化成功 -10：元数据提取失败，-15：无图碎片化失败，-20：有图碎片化失败

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
documentId 文档主键id query true string
processId 调用上传解析文件接口拿到的processId query true string
dbCode query false string
fileCode 网盘的文件code query false string
productType 产品类型（journal、book、conference、yearbook、newspaper、dissertation、standard），默认journal query false string
status 查询标引状态，-1:标引失败，1:标引成功，0:处理中， 10：元数据提取成功，15：无图碎片化成功，20：有图碎片化成功 -10：元数据提取失败，-15：无图碎片化失败，-20：有图碎片化失败 query false integer(int32)
userId query false string
xmlName 碎片化后的文件名，若上传接口中的cnkiinfor有数据，则应用数据，无则是filecode的xml文件 query false string

响应状态:

状态码 说明
200 OK
404001 系统异常
404011 参数缺失
404401 参数校验失败
404402 接口权益异常
404406 会员权限不足
404500 参数错误

响应参数:

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

响应示例:

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

# 获取解析标引结果

接口地址:/psmc/file/mark/infos

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取标引状态:-1=接口异常,2=标引执行完毕

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
documentId 文档主键id query true string
processId 调用上传解析文件接口拿到的processId query true string
dbCode query false string
fileCode 网盘的文件code query false string
productType 产品类型（journal、book、conference、yearbook、newspaper、dissertation、standard），默认journal query false string
status 查询标引状态，-1:标引失败，1:标引成功，0:处理中， 10：元数据提取成功，15：无图碎片化成功，20：有图碎片化成功 -10：元数据提取失败，-15：无图碎片化失败，-20：有图碎片化失败 query false integer(int32)
userId query false string
xmlName 碎片化后的文件名，若上传接口中的cnkiinfor有数据，则应用数据，无则是filecode的xml文件 query false string

响应状态:

状态码 说明
200 OK
404001 系统异常
404011 参数缺失
404401 参数校验失败
404402 接口权益异常
404406 会员权限不足
404500 参数错误

响应参数:

参数名称 参数说明 类型 schema
code 接口返回状态码 integer(int32) integer(int32)
content 接口返回数据 array MyStudyLiteratureWithReference
  author string
  citationTimes string
  dbCode string
  doi string
  downloads string
  fileCode string
  fileType string
  fund string
  info string
  issn string
  issue string
  keyWord string
  language string
  literatureState string
  page string
  pageNum string
  postTime string
  printPage string
  product string
  publisher string
  pykm string
  refUserReferenceList 用户上传文献参考文献列表 array UserUploadReferenceLiterature
    createTime 创建时间 string
    id 主键 string
    noteCount 笔记数量 number
    referenceAuthor 参考文献作者 string
    referenceCnkiFileName 参考文献cnki文件名 string
    referenceDbCode 参考文献Dbcode string
    referenceEnAuthor 参考文献英文作者 string
    referenceEnSource 参考文献英文来源 string
    referenceEnTitle 参考文献英文标题 string
    referenceFileCategory 参考文献种类：1=cnki中文；2=cnki外文；3=用户上传；4=用户手动添加 string
    referenceFileCode 参考文献文件名 string
    referenceFileType 参考文献类型：学位论文（D）、会议等 string
    referenceIndex 参考文献顺序 string
    referenceIsCnkiInclude 参考文献是否被cnki收录 string
    referenceIsHaveOrginal 参考文献是否有原文 string
    referenceIssue 参考文献期 string
    referenceLanguage 参考文献语种 string
    referenceQuoteFormat 参考文献引文格式 string
    referenceReadUrl 参考文献阅读地址 string
    referenceRegisterDoi 注册DOI string
    referenceSource 参考文献来源 string
    referenceSourceDB 参考文献来源数据库 string
    referenceTableName 参考文献TableName string
    referenceTitle 参考文献中文标题 string
    referenceUnit 参考文献作者单位 string
    referenceUrl 参考文献地址 string
    referenceVolume 参考文献卷 string
    referenceYear 参考文献年 string
    updateTime 更新时间 string
  relatedLiterature string
  resourceType string
  source string
  summary string
  tableName string
  title string
  url string
  volume string
  year string
count 接口返回数据条数，用于分页查询 integer(int32) integer(int32)
message 接口返回信息 string
success 接口返回是否成功 boolean
total 接口返回数据条数，用于分页查询 integer(int32) integer(int32)

响应示例:

{
	"code": 0,
	"content": [
		{
			"author": "",
			"citationTimes": "",
			"dbCode": "",
			"doi": "",
			"downloads": "",
			"fileCode": "",
			"fileType": "",
			"fund": "",
			"info": "",
			"issn": "",
			"issue": "",
			"keyWord": "",
			"language": "",
			"literatureState": "",
			"page": "",
			"pageNum": "",
			"postTime": "",
			"printPage": "",
			"product": "",
			"publisher": "",
			"pykm": "",
			"refUserReferenceList": [
				{
					"createTime": "",
					"id": "",
					"noteCount": 0,
					"referenceAuthor": "",
					"referenceCnkiFileName": "",
					"referenceDbCode": "",
					"referenceEnAuthor": "",
					"referenceEnSource": "",
					"referenceEnTitle": "",
					"referenceFileCategory": "",
					"referenceFileCode": "",
					"referenceFileType": "",
					"referenceIndex": "",
					"referenceIsCnkiInclude": "",
					"referenceIsHaveOrginal": "",
					"referenceIssue": "",
					"referenceLanguage": "",
					"referenceQuoteFormat": "",
					"referenceReadUrl": "",
					"referenceRegisterDoi": "",
					"referenceSource": "",
					"referenceSourceDB": "",
					"referenceTableName": "",
					"referenceTitle": "",
					"referenceUnit": "",
					"referenceUrl": "",
					"referenceVolume": "",
					"referenceYear": "",
					"updateTime": ""
				}
			],
			"relatedLiterature": "",
			"resourceType": "",
			"source": "",
			"summary": "",
			"tableName": "",
			"title": "",
			"url": "",
			"volume": "",
			"year": ""
		}
	],
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

# 根据DOI查询文献题录

接口地址:/psmc/file/doi/tilu/infos

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:根据DOI查询文献题录,查询知网库版本

请求参数:

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

响应状态:

状态码 说明
200 OK
404001 系统异常
404011 参数缺失
404401 参数校验失败
404402 接口权益异常
404406 会员权限不足
404500 参数错误

响应参数:

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

响应示例:

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

# 根据条件查询题录和参考文献列表

接口地址:/psmc/file/references/tilu/infos

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
documentId 文档主键id query true string

响应状态:

状态码 说明
200 OK
404001 系统异常
404011 参数缺失
404401 参数校验失败
404402 接口权益异常
404406 会员权限不足
404500 参数错误

响应参数:

参数名称 参数说明 类型 schema
code 接口返回状态码 integer(int32) integer(int32)
content 接口返回数据 MyStudyLiteratureWithReference MyStudyLiteratureWithReference
  author string
  citationTimes string
  dbCode string
  doi string
  downloads string
  fileCode string
  fileType string
  fund string
  info string
  issn string
  issue string
  keyWord string
  language string
  literatureState string
  page string
  pageNum string
  postTime string
  printPage string
  product string
  publisher string
  pykm string
  refUserReferenceList 用户上传文献参考文献列表 array UserUploadReferenceLiterature
    createTime 创建时间 string
    id 主键 string
    noteCount 笔记数量 number
    referenceAuthor 参考文献作者 string
    referenceCnkiFileName 参考文献cnki文件名 string
    referenceDbCode 参考文献Dbcode string
    referenceEnAuthor 参考文献英文作者 string
    referenceEnSource 参考文献英文来源 string
    referenceEnTitle 参考文献英文标题 string
    referenceFileCategory 参考文献种类：1=cnki中文；2=cnki外文；3=用户上传；4=用户手动添加 string
    referenceFileCode 参考文献文件名 string
    referenceFileType 参考文献类型：学位论文（D）、会议等 string
    referenceIndex 参考文献顺序 string
    referenceIsCnkiInclude 参考文献是否被cnki收录 string
    referenceIsHaveOrginal 参考文献是否有原文 string
    referenceIssue 参考文献期 string
    referenceLanguage 参考文献语种 string
    referenceQuoteFormat 参考文献引文格式 string
    referenceReadUrl 参考文献阅读地址 string
    referenceRegisterDoi 注册DOI string
    referenceSource 参考文献来源 string
    referenceSourceDB 参考文献来源数据库 string
    referenceTableName 参考文献TableName string
    referenceTitle 参考文献中文标题 string
    referenceUnit 参考文献作者单位 string
    referenceUrl 参考文献地址 string
    referenceVolume 参考文献卷 string
    referenceYear 参考文献年 string
    updateTime 更新时间 string
  relatedLiterature string
  resourceType string
  source string
  summary string
  tableName string
  title string
  url string
  volume string
  year string
count 接口返回数据条数，用于分页查询 integer(int32) integer(int32)
message 接口返回信息 string
success 接口返回是否成功 boolean
total 接口返回数据条数，用于分页查询 integer(int32) integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"author": "",
		"citationTimes": "",
		"dbCode": "",
		"doi": "",
		"downloads": "",
		"fileCode": "",
		"fileType": "",
		"fund": "",
		"info": "",
		"issn": "",
		"issue": "",
		"keyWord": "",
		"language": "",
		"literatureState": "",
		"page": "",
		"pageNum": "",
		"postTime": "",
		"printPage": "",
		"product": "",
		"publisher": "",
		"pykm": "",
		"refUserReferenceList": [
			{
				"createTime": "",
				"id": "",
				"noteCount": 0,
				"referenceAuthor": "",
				"referenceCnkiFileName": "",
				"referenceDbCode": "",
				"referenceEnAuthor": "",
				"referenceEnSource": "",
				"referenceEnTitle": "",
				"referenceFileCategory": "",
				"referenceFileCode": "",
				"referenceFileType": "",
				"referenceIndex": "",
				"referenceIsCnkiInclude": "",
				"referenceIsHaveOrginal": "",
				"referenceIssue": "",
				"referenceLanguage": "",
				"referenceQuoteFormat": "",
				"referenceReadUrl": "",
				"referenceRegisterDoi": "",
				"referenceSource": "",
				"referenceSourceDB": "",
				"referenceTableName": "",
				"referenceTitle": "",
				"referenceUnit": "",
				"referenceUrl": "",
				"referenceVolume": "",
				"referenceYear": "",
				"updateTime": ""
			}
		],
		"relatedLiterature": "",
		"resourceType": "",
		"source": "",
		"summary": "",
		"tableName": "",
		"title": "",
		"url": "",
		"volume": "",
		"year": ""
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

← 模板服务 →