数据协议接口设计.docxVIP

数据协议接口设计 　　篇一：xxx系统数据对接接口说明-设计 　　XXXXXX管理系统  　　数据接口说明  　　版 本：  　　修改时间：XX年11月  　　定稿时间：*年*月 　　目录 　　目录 ............................................................................................................. 2  　　一、 主要内容........................................................................................... 2  　　二、 流程文件及风险点数据接口 .......................................................... 2  　　（1） 流程文件及风险点概念说明 ................................................ 2  　　（2） 使用过程说明 ........................................................................ 3  　　（3） 接口说明 ................................................................................ 3  　　 接口概述 ......................................................................... 3  　　 接口调用方式 ................................................................. 4  　　 接口文件概述 ................................................................. 5  　　一、 主要内容  　　门户对外提供如下接口：  　　? XXXXXX系统流程文件及风险点数据接口  　　二、 流程文件及风险点数据接口  　　（1） 流程文件及风险点概念说明  　　流程文件 　　? 指包含业务流程的制度文件 　　? 一个业务流程可对应多个子流程，子流程即为流程文件所包含的各个业务流程图  　　? 一个子流程一定被包含在某个业务流程关系的节点  　　风险点  　　? 指流程文件中的子流程在某个环节可能涉及到的风险  　　? 一个业务流程文件可对应多个子流程，一个子流程可以对应多个业务环节，一个业务环节可对应多个风险点  　　（2） 使用过程说明  　　使用过程如下：  　　? 外部系统开发者和XX系统管理员协商，确定外部系统的IP地址及权限协议等（XX系统提供的是FTP文件传输协议提供数据）  　　? 外部系统想要获取文件必输建立与XX系统连接的FTP协议通道  　　? 外部系统获取的文件为完整的XML文件，通过FTP下载到本地后解析能获取完整的数据  　　（3） 接口说明  　　 接口概述  　　由于XX系统中已入库的流程文件及风险点不允许二次修改，所 　　以不提供修改增量数据，但提供废止、删除增量数据。数据接口如下： 　　? 导出完整的流程文件及风险点数据  　　外部系统可以通过XX接口获得一整套全量数据，从而建立起本系统所需要的流程文件及风险点，而无须从零开始建立。  　　? 导出废止流程文件增量数据  　　外部系统还可以通过XX接口获得这些流程文件的最新状态，是否已被废止。使得外部系统可以方便地和XX数据保持一致。  　　? 导出删除流程文件增量数据  　　外部系统还可以通过XX接口获得这些流程文件的最新状态，是否已被删除。使得外部系统可以方便地和XX数据保持一致。  　　 接口调用方式  　　数据导出接口是以FTP方式提供的，需要通过FTP协议向XX系统发送请求，服务器地址是：http://服务器域名/CMS/$DATE/  　　URL解释：  　　http://服务器域名/cms：XX系统的访问地址  　　$DATE：XX系统建立的当天的文件夹，通过日期文件夹管理数据，避免数据重复以及提供了完整的历史记录 　　：当天具体的数据文件（这里为流程文件数据） ：当天具体的数据文件（这里为风险点数据） 调用举例： 　　在浏览器中，输入http://服务器域名/CMS/$DATE/，服务器会输出一个以gbk方式编码的xml文本，文本内容是XX系