xxx系统数据对接接口说明-设计
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
XXXXXX管理系统
数据接口说明
版本：1.0
修改时间：2014年11月
定稿时间：*年*月
目录
目录 (2)
一、主要内容 (2)
二、流程文件及风险点数据接口 (2)
（1）流程文件及风险点概念说明 (2)
（2）使用过程说明 (3)
（3）接口说明 (3)
2.3.1. 接口概述 (3)
2.3.2. 接口调用方式 (4)
2.3.3. 接口文件概述 (5)
一、主要内容
门户对外提供如下接口：
XXXXXX系统流程文件及风险点数据接口
二、流程文件及风险点数据接口
（1）流程文件及风险点概念说明
流程文件
⏹指包含业务流程的制度文件
⏹一个业务流程可对应多个子流程，子流程即为流程文件所包含
的各个业务流程图
⏹一个子流程一定被包含在某个业务流程关系的节点
风险点
⏹指流程文件中的子流程在某个环节可能涉及到的风险
⏹一个业务流程文件可对应多个子流程，一个子流程可以对应多
个业务环节，一个业务环节可对应多个风险点
（2）使用过程说明
使用过程如下：
⏹外部系统开发者和XX系统管理员协商，确定外部系统的IP
地址及权限协议等（XX系统提供的是FTP文件传输协议提
供数据）
⏹外部系统想要获取文件必输建立与XX系统连接的FTP协议
通道
⏹外部系统获取的文件为完整的XML文件，通过FTP下载到
本地后解析能获取完整的数据
（3）接口说明
2.3.1.接口概述
由于XX系统中已入库的流程文件及风险点不允许二次修改，所
以不提供修改增量数据，但提供废止、删除增量数据。数据接口如下：
⏹导出完整的流程文件及风险点数据
外部系统可以通过XX接口获得一整套全量数据，从而建立
起本系统所需要的流程文件及风险点，而无须从零开始建
立。
⏹导出废止流程文件增量数据
外部系统还可以通过XX接口获得这些流程文件的最新状
态，是否已被废止。使得外部系统可以方便地和XX数据保
持一致。
⏹导出删除流程文件增量数据
外部系统还可以通过XX接口获得这些流程文件的最新状
态，是否已被删除。使得外部系统可以方便地和XX数据保
持一致。
2.3.2.接口调用方式
数据导出接口是以FTP方式提供的，需要通过FTP协议向XX系统发送请求，服务器地址是：http://服务器域名/CMS/$DATE/cmpfile.xml
URL解释：
http://服务器域名/cms：XX系统的访问地址
$DATE：XX系统建立的当天的文件夹，通过日期文件夹管理数据，避免数据重复以及提供了完整的历史记录
cmpfile.xml：当天具体的数据文件（这里为流程文件数据）Risk.xml：当天具体的数据文件（这里为风险点数据）
调用举例：
在浏览器中，输入http://服务器域名/CMS/$DATE/cmpfile.xml，服务器会输出一个以gbk方式编码的xml文本，文本内容是XX系统当天流程文件的新增、废止、删除的完整数据。（第一次同步时XX系统会提供一个日期为2088/08/08的文件夹，里面存放了XX 系统的全量数据，如果日后有需要XX系统可以更新该文件下的全量数据内容）
2.3.3.接口文件概述
如果外部系统没有获得授权就调用上述接口，则有可能返回如下的信息：
1，无法访问，如下图：
2，提示无权限访问
如果调用正常，可直接获取xml格式文件。（参照第四部分）
（4）接口操作明细
2.4.1.外部系统（下面简称系统A）从XX取数据
分为三步：
①获取XX系统当天存储文件的文件地址
②根据获取的文件地址通过FTP协议将需要同步的文件下载到系
统A服务器中
③通过代码对该XML文件进行解析，通过节点
数据同步类型，一共三个值：1、新增；2、废止；3、删除。然后进行对应的数据库操作
下面为样例（实际节点名称以开发为准）：
//文件编码方式
<...>