
接口及解决方案说明书.docx
35页完好接口及解决方案说明书.文档编号: T-JKJS文档版本: 项目编号: XX-DX- PECS《XX电信工程外面协作系统》Project Exterior Cooperation System施工单位接口技术解决方案编写人:南疯日期:2006-10-30审查人:日期:赞同人:日期:XXXXXX信息科技股份有限企业地址: XXXXXXX 邮编: XXXXXX: XXXXXXXX : XXXXXX网站: XXXXXXXXX更正记录( Revision Chart )版本号 赞同人 更正人 更正 南疯 2006-10-300.02 详细更正记录:序号1 序言 / word 范文.编写目的覆盖范围预期读者与阅读建议文档约定术语与缩略语参照文件2 归纳3 接口方式4 接口安全接口认证数据安全5 事务办理6 性能考虑7 容错办理8 数据格式约定施工系统向外协系统发送央求央求盘问一个业务数据新增一条记录,获得记录的键值更正一条记录删除一条记录文档上传一条记录中一个文档字段上传多个文件补充上传文档在记录中删除一个文档获得文档的基本信息获得文档的全部兄弟信息获得文档的全部父亲信息下载一个文档获得字典外协系统向施工系统发送央求发送更正后的数据发送更正后的字典文档发送央求9 信息数据项数据表字段信息字典种类10 网页地址word 范文.11 Web Service 接口 接口命名规范 输入参数 输出参数 外协系统供给的其他接口12 附录:待定问题1 序言 编写目的本文档为 XX电信工程外面协作系统 (以下简称外协系统) 与电信工程施工单位内部系统 (以下简称施工系统) 接口技术解决方案, 以此作为外协系统与施工系统推行接口的技术方案依照和项目设计标准。
覆盖范围XX 电信工程外面协作系统项目组施工系统接口开发技术组 预期读者与阅读建议XX 电信企业信息化部XX 电信工程建设部XXXX 企业开发人员施工系统开发人员 文档约定粗体正文 表示重申内容红色正文 表示未完成或需要今后考虑的内容蓝色正文 表示待谈论内容 术语与缩略语术语、缩略语 定 义外协系统 XX电信工程外面协作系统word 范文.施工系统 电信工程施工单位内部系统PECS XX电信工程外面协作系统英文简称 参照文件(XXXX)2 归纳建设 XX电信工程外面协作系统的目标, 是在工程项目的管理、 建设、使用和推行单位之间搭建起数据交换和共同工作的信息平台, 延伸与拓展工程建设管理信息化的应用范围, 实现通讯工程建设过程的信息化管理, 促进工程项目的管理部门、 建设部门、 推行部门和使用部门之间业务流程协调有序地睁开,实现工程项目设计、施工、监理管理功能,将相关的设计、施工、监理单位纳入到工程建设管理中, 完满工程项目建设过程管理系统, 经过信息化推动管理的规范化, 在信息化的应用过程中不断研究市场环境下工程建设管理的新思路和新方法依照工程部业务工作的本质情况, 项目第一满足工程建设管理中应用最广泛、 问题最突出的基本需求。
项目功能需求包括:建立工程外面协作系统与 MSS等系统的接口;建立设计协作服务、监理协作服务、施工协作服务模块,为邮电设计院、监理企业和电信工程企业供给工程部所需的协作服务,保证工程建设推行流程的睁开;在建立工程协作服务模块的基础上,建立工程外面协作系统与邮电设计院、监理企业、电信工程企业信息系统的接口, 实现工程部与三家推行单位的信息交互与业务协作;本技术解决方案就是针对实现工程建设部与三家推行单位信息交互与业务协作接口中施工单位接口的技术解决方案的组成部分在接口的调用过程中,存在施工系统调用外协系统接口的情况,这时候,施工系统作为客户端,外协系统作为服务端;也存在外协系统调用施工系统的情况,这时候,外协系统作为客户端,施工系统作为服务端本方案中,除了特别别的说明外,不考虑外协系统和施工系统角色换位的问题若是一方倡导了调用,那么它就是客户端,另一方就是服务端反之亦然4 接口方式工程外协系统与施工系统之间的接口采用 Web Service 接口形式来进行业务数据的交互接口数据传输采用 XML数据交换格式, utf-8 编码word 范文.在外协系统中供给 Web Service 的 API 接口。
供给由施工系统调用获守信息;而且供给施工系统提交信息的 API 接口同样,在施工系统中供给 Web Service 的 API 接口供给由外协系统提交信息的 API 接口考虑到工程外协中的数据信息不但包括了 XX电信工程企业的数据而且还包括了其他的施工单位的数据信息而这些单位也各有其各自工程应用系统这样,外协系统对各个施工单位系统所供给的接口 API 及其参数信息、格式均是一致的同时,也要求各个施工单位所供给的接口 API 及其参数、格式等也必定要求一致外协系统与施工系统属于一对多的关系外协系统要求能够有目的,信息有过滤的把业务信息经过接口正确的发送给相应施工系统接口非相关的信息不要发送给对应的施工系统施工系统建立用户映像比较表、字典比较表、单位比较表等数据映像,传达给外协的数据使用的是映像中变换后的外协系统能够鉴别数据;同时,接收到的数据也依照比较表变换成各自能够讲解的数据格式数据初始化的时候, 由施工系统主动调用外协系统的接口, 以获得用户信息、 字典信息、单位信息、项目信息等基础信息今后,一旦发生数据的变动,由外协系统主动往施工系统发送信息外协系统不主动央求施工系统获得数据,但是外协系统会主动央求施工系统发送数据。
施工系统主动央求外协系统获得数据,也会主动央求外协系统发送数据4 接口安全 接口认证调用认证:诚然接口双方都是存在于电信内部网络中, 但是,仍不能够消除接口服务被攻击、 恶意调用以及非法调用等因此,从接口调用上,必定考虑调用的认证安全问题本方案中的接口,在客户端调用服务端的时候,必定经过调用身份认证考虑施工系统的开发平台的多样性, 但同时接口服务运行平台都是 Windows的情况,本方案采用 Windows安全身份认证的方式即在接见接口所在的服务的时候,都必定进行资格审查(使用Credentials 发送认证信息)别的,接口采用 SOAP协议,因此在接口配置上面需要障蔽 HTTPGET 和 HTTPPOST等其他协议在接口中审查并进行日志的记录使用最低权限的进度帐户运行 Web 服务(经过 中的
同时,业务用户认证中的用户信息也是记录接口日志中的重要组成部分本方案采用的是在接口信息中包括业务认证用户信息的方式来进行认证 服务端在收到央求的时候, 应先考据业务的授权用户, 若是该业务用户没有执行当前业务的权限, 应停止业务的执行,并给出非法用户的警告信息反响回客户端一般情况下, 业务认证的用户是系统中的用户 业务认证其实就是应用系统认证的组成部分业务认证的用户信息经过加密此后包括在要发送的信息( XML体)中,即在发送的信息中包括业务用户的信息(拜会下面的数据格式说明) 数据安全数据的安全表现为如何保证数据在网络传输过程中不会被截获并被解析其中的内容而引起信息泄露与如何保证数据在传输的过程中的数据的完满性两个方面WebService 采用 XML数据格式来传输信息因此,无论是发送数据还是返回结果,都要求采用对 XML数据加密之今后传输至于采用何种方式的加密技术,本方案为了保密, 只能在开发的时候由开发人员口头见告涉及到加密技术就要涉及到加密的密钥问题当前,外协系统和施工系统接口上有好多各种类的业务,终究是每各种类的业务采用不一样的密钥,还是按分组来采用同一种密钥的方式,还是全部的业务全部采用同一种的密钥的方式,依照需求各有不一样的选择。
本方案采用的是最后一种的方式密钥的宣布由作为服务方来宣布,由客户端获得密钥的宣布方式待定为了保证数据的完满性, 第一:方案采用数据签字 ( SOAPSecurityExtensions:DigitalSignature )利用 XML的数字签字( XML Digital Signature syntax [XML-Signature])对SOAP进行扩展, 在 SOAP的头元素中定义签字属性 (
