You are on page 1of 12

JCMS_OPEN1.0.

1
使用手册

大汉软件股份有限公司
2019 年 10 月
目录

1. 概述................................................................................................................................................. 2

2. 登录............................................................................................................................................2

3. 系统后台.....................................................................................................................................2

3.1 应用管理..........................................................................................................................3

3.1.1 权限管理................................................................................................................ 3

3.1.2 外部应用................................................................................................................ 4

3.2 在线 API............................................................................................................................5

3.2.1 API 手册入口.......................................................................................................... 5

3.2.2 在线调试入口......................................................................................................... 5

3.2.3api 接口.......................................................................................................................... 6

3.3 日志查看........................................................................................................................ 9

第 1 页/共9页
1 概述
本应用旨在对外提供一套统一的接口规范,第三方只需与本应用对接即可实现对荆门

市集约化内容管理系统接口的调用。

2 登录
登陆前请注意:http://www.jingmen.gov.cn/open/login.do

第 2 页/共9页
3 系统后台
用户登录后台后,如图 3 -1 页面所示:

图 3-1

3.1 应用管理

3.1.1 权限管理

权限管理主要用于管理接口调用的限制,如:开始、结束的时间、以及时间段内的次

数限制,点击新增按钮,如图 3-2 所示

第 3 页/共9页
图 3-2

注: 带*号的为必填项,调用次数有上限。

3.1.2 外部应用

对接荆门市集约化内容管理系统需在 jcms_open 中建立对应的应用,点击新增按钮,

填写应用名称、选择权限以及绑定荆门市集约化内容管理平台的网站栏目,唯一标识和密

钥为自动生成,调用接口时会用到。如图 3-3 所示:

图 3-3
点击设定 ip,将 ip 填写并保存,才有权限调用接口,若在黑名单中设置了某 ip,则该 ip

无权限调用接口,如图 3-4 所示:

第 4 页/共9页
图 3-4

3.2 在线 API

3.2.1 API 手册入口

进入 API 手册入口,手册里详细介绍了 jcms_open 里各个接口的使用方法,调用接口

前请务必仔细参考阅读。

3.2.2 在线调试入口

在线调试入口,即为使用各个接口的地方,使用接口前,请先调用签名生成工具接口

生成签名,如图 3-5:

第 5 页/共9页
图 3-5
依次输入应用 id、唯一标识和密钥,点击提交,会生成签名和时间戳,该签名和时间

戳在调用其他接口时会使用到。
文件上传接口:输入 appid、签名、时间戳和文件路径,文件路径为服务器路径,且

必须明确到文件名(包括扩展名);点击提交,结果显示返回码,详细返回码信息请参考

系统中的 API 手册入口。如图 3-6 所示:

第 6 页/共9页
图 3-6
多信息同步接口:输入 appid、签名、时间戳以及 jcms 中需要接收该信息的多信息栏

目的 id,并且将组织好的信息 json 填入 articleInfo 中,点击提交,结果显示返回码。元

数据同步接口与多信息同步类似,需要注意的是栏目 id 为 jcms 中元数据栏目 id。


获取完整信息(多信息格式):依次填写 appid、签名、时间戳、栏目 id、起始值、

结束值、以及是否包含引用信息、正序倒序等,其中 nStart 为起始值、nEnd 为结束值,

且间隔无法大于 50。填写完毕之后,点击提交,结果显示返回码。
获取完整信息(元数据格式)与前者类似,需要注意的是栏目 id 为元数据栏目 id。
获取信息部分内容口接:即获取信息的内容不包括正文内容、图片和附件。

3.2.3api 接口

功能:签名生成
接口地址:http://www.jingmen.gov.cn/open/external/sign/getSign.do

方法名:getSign

参数:

• 参数名称 • Java数据类型 • 参数说明

第 7 页/共9页
• appId • String • 应用ID

• key • String • 密钥

• identity • String • 唯一标识

功能:上传同步信息里的图片附件等
接口地址:http://dh.jingmen.gov.cn/open /external/file/upload.do

方法名:fileUpload

参数:

• 参数名称 • Java数据类型 • 参数说明

• appId • String • 应用ID

• accessTime • String • 访问时间戳(毫秒数)

• appSign • String • 应用签名

• multipartFile • File • 文件

其中,图片文件后缀包括:gif,jpg,png,jpeg;动画后缀包括:swf;附件后缀包括:

docx,doc,xlsx,xls,pptx,ppt,pdf,txt,zip,rar,apk;视频后缀包括:flv,mp4

功能:同步多信息
接口地址:
http://www.jingmen.gov.cn/open/external/article/synchronize/articlesynchronize.do

方法名:synchronizeArticle

参数:

• 参数名称 • Java数据类型 • 参数说明

• appId • String • 应用ID

第 8 页/共9页
• accessTime • String • 访问时间戳(毫秒数)

• appSign • String • 应用签名

• nCataId • Integer • 栏目ID

• articleInfo • String • 同步信息的Json

功能:获取多信息的完整内容(包括图片、附件)。
接口地址:http://www.jingmen.gov.cn/open /external/article/receive/findMultiInfos.do( IP或
域名和应用名称请以真实环境为准 )
方法名:findMultiInfos
• 参数:

• 参数名称 • Java数据类型 • 参数说明

• appId • String • 应用ID

• accessTime • String • 访问时间戳(毫秒数)

• appSign • String • 应用签名

• nCataId • Integer • 栏目ID

• nStart • Integer • 起始值(必须>=0)

• nEnd • Integer • 结束值(必须>=1)

• b_ref • Integer • 是否获取引用信息(0=否,1=是)

• bAsc • Integer • 按创建时间排序(0=倒序,1=正序)

• strStartCTime • String • 查询的区间时间起始值

第 9 页/共9页
• strEndCTime • String • 查询的区间时间结束值

功能 :获取元数据信息的完整内容(包括图片、附件)。
接口地址:http://IP:port/jcmsopen/external/article/receive/findGenInfos.do( IP或域名和应用
名称请以真实环境为准 )
方法名:findGenInfos
参数:

• 参数名称 • Java数据类型 • 参数说明

• appId • String • 应用ID

• accessTime • String • 访问时间戳(毫秒数)

• appSign • String • 应用签名

• nCataId • Integer • 栏目ID

• nStart • Integer • 起始值(必须>=0)

• nEnd • Integer • 结束值(必须>=1)

• b_ref • Integer • 是否获取引用信息(0=否,1=是)

• bAsc • Integer • 按创建时间排序(0=倒序,1=正序)

• strStartCTime • String • 查询的区间时间起始值

• strEndCTime • String • 查询的区间时间结束值

第 10 页/共9页
3.3 日志查看

日志查看功能记录接口调用的情况,还可以根据接口类型、应用 id、请求 ip 以及时

间条件惊进行检索。默认只显示当天的记录。

第 11 页/共9页

You might also like