行业应用分析平台及应用系统接口规范 v1.0

1、文档名称文档密级行业应用分析平台与应用系统接口规范哈尔滨贯中网络科技有限公司All rights reserved版权所有 侵权必究Revision Record 修订记录Date日期Revision Version修订版本Change Description修改描述Author作者2009-8-311.0初稿孟灵敏Catalog 目 录1总体概述41.1起草单位41.2说明41.3名词解释41.3.1CAA41.3.2SI系统41.3.3业务注册码42CAA平台与SI系统接口定位43CAA平台与SI系统接口协议53.1基本协议53.2接口描述53.3消息格式53.4消息完整性83.5消息安全

2、性93.6接口调用方法（java实现）94CAA平台与SI系统接口描述114.1SOAP接口114.1.1注册登记接口114.1.2工作流接口134.1.3通知公告接口134.1.4邮件接口134.2FPT接口134.2.1通讯录接口145接口说明146附录146.1一：CAA平台提供给SI的WSDL文件146.1.1基础信息接口的wsdl146.2三：SOAP官方规范146.3四：WSDL官方规范146.4五：消息打包解包java类及说明146.4.1Jar包146.4.2示例工程(java实现)151 总体概述1.1 起草单位本文档的起草单位为哈尔滨贯中网络科技有限公司。1.2 说明为了帮

3、助SI开发可接入行业应用分析平台的应用，特制定本规范。本规范规定了SI系统与行业应用分析平台之间的应用层的接口及协议。规范说明了在开通、使用中小企业信息化应用业务过程中行业应用分析平台与SI系统交互的流程，并对流程中涉及的接口进行了定义。本规范用于指导SI应用系统与行业应用分析平台接口的实现，SI向行业应用分析平台发起和接收请求的接口都应遵从该规范。1.3 名词解释1.3.1 CAACAA：Customer Application Analysis Platform (客户应用分析)，CAA是贯中网络为运营商提供的中小企业信息化平台产品，即CAA平台。1.3.2 SI系统SI：Service

4、Integrator（应用服务集成商），运营商的主要合作伙伴之一，可以提供各种类型的企业信息化的产品及方案，具有成熟的产品及技术能力。1.3.3 业务注册码SI系统分配给企业的代码，业务注册码标识一个企业的某一指定业务的注册码，便于SI管理自己的业务系统。业务注册码由SI业务系统生成，同时需要同步到CAA平台。2 CAA平台与SI系统接口定位SI业务系统CAA平台BOSSCAA平台与SI业务接口3 CAA平台与SI系统接口协议3.1 基本协议双方的消息交互采用FTP和SOAP混合接口。FTP（File Transfer Protocol），是文件传输协议的简称，用于Internet上的控制文件

5、的双向传输；SOAP（Simple Object Access Protocol，简单对象访问协议）是一个可以运行在任何传输协议上的轻量级协议，它包含三个方面：XML-envelop为描述信息内容和如何处理内容定义了框架；将程序对象编码成为XML对象的规则；执行远程调用（RPC，Remote Procedure Call）的约定。FTP接口用于大数据量数据的传输，如日志及报表等数据的上传。基础数据的传输使用SOAP接口。SOAP接口承载于HTTP协议之上。3.2 接口描述我们用WSDL（Web Services Description Language）来对接口进行描述。WSDL是用来定义We

6、b服务的属性以及如何调用它的一种XML语言。一个完整的WSDL服务描述是由一个服务接口和一个服务实现文档组成的。通过查阅Web服务的WSDL文档，开发者可以知道Web提供了哪些方法和如何用正确的参数调用他们。因为WSDL包含了对服务接口的完整描述，所以我们可以使用它来创建能简化服务访问的存根，该存根为一段Java代码（假设使用Java），它自动生成了访问Web服务的类。如果我们需要访问Web服务，只需调用该类中对应的方法即可，而不用在客户端程序中再写入配置信息。3.3 消息格式本文所描述的所有消息，都基于下图所示的层次进行封装：以下是企业绑定消息进行封装后的完整数据示例：POST /IfAPS

7、ervice HTTP/1.0Content-Type: text/xml; charset=utf-8Accept: application/soap+xml, application/dime, multipart/related, text/*Host: 53:80Cache-Control: no-cachePragma: no-cacheSOAPAction: Content-Length: 1517 协议数据单元PDU 所有的协议数据单元PDU都是xml格式的字符串，由如下表的消息头和消息体组成： PDU组成描述Message Header消息头Message

8、 Body消息体消息头和消息体在xml中的表现形式如下： 消息头属性一消息头属性二消息头属性三加密后的消息体未加密的消息体也是一个的完整的xml文件，如下例所示：消息体属性一消息体属性二消息体属性三消息体的加密算法为：Base64(DES(MD5(消息体) + 消息体)。在第4章节中对消息格式的描述，都是指对协议数据单元的描述。3.4 消息完整性数字签名使用强大的加密技术和公钥基础结构，以更好地保证文档的真实性、完整性和受认可性。数字签名可以提供端到端的消息完整性保证，可以提供有关消息发件人的验证信息，可以在最终使用和处理消息时对签名进行验证。数字签名对消息内容提供完整性检查，如果原始内容的某

9、个字节已经被修改，那么签名验证将失败。数字签名算法：MD5(消息体)。3.5 消息安全性Des加密保证消息的不可阅读性。对消息的加密算法：Base64(DES(MD5(消息体) + 消息体）消息采用的DES加密算法规则如下：1密钥是一个长度16、由16进制字符组成的字符串，如：1234567890ABCDEF使用时，相临的两位理解为一个16进制数的明文，然后转换为实际使用的8位密钥2 待加密数据按照PKCS5规则进行补位。（缺7位补7个0x07，缺6位则补6个0x06，以次类推，如果正好8位，也需要补8个0x08）3 实际加密模式选择DES-ECB4 经过DES加密后的数据必须通过Base64

10、编码转换为明文的字符串3.6 接口调用方法（java实现）1 假设提供soap接口的服务端地址为” :808/IfSoapDemo”2 访问WEB地址” :808/IfSoapDemo?wsdl”获得wsdl文档3 假定文档中说明该调用接口的类方法String do(String smg)4 Java中调用该接口的简单示例代码如下：try String endpoint = :808/IfSoapDemo; org.apache.axis.client.Service service = ne

11、w org.apache.axis.client.Service(); org.apache.axis.client.Call call = null; call = (org.apache.axis.client.Call) service.createCall(); call.setOperationName(new space.QName(endpoint,do);call.setTargetEndpointAddress(new .URL(endpoint);String smg = “testParameter”; String ret = (String

12、)call.invoke(new Objectsmg); catch (ServiceException ex) ex.printStackTrace();5 用JBuilder等集成开发环境可以更加方便的生成相关调用代码。4 CAA平台与SI系统接口描述4.1 SOAP接口4.1.1 注册登记接口用户安装SI业务系统后，在用户初次访问业务系统时业务系统应调用CAA平台提供的注册登记接口。将SI业务系统的使用用户信息提交之CAA平台。RegisterReq鉴权请求消息参数标识RegisterReq消息格式 消息标志消息序列号时间戳业务代码加密后的消息体名称说明数据类型长度（字节）CODE消息标

13、志：registerString32SID消息序列号，自行生成Long-TIMESTAMP系统时间戳：YYYMMDDHHmmssnnnnString24SERVICEID业务代码String32未加密的消息体格式消息体格式企业名称企业序列号企业注册码企业IP地址企业IP地址登记用户数名称说明数据类型长度（字节）ENTNAME企业名称String32SERIALNO 企业序列号String64REGCODETOKEN企业注册码String64WANIP企业内网IP地址String15LANIP企业外网IP地址String15USERCOUNT登记用户数String8RegisterRsp鉴权响应

14、消息参数标识RegisterRsp消息格式 消息标志消息序列号时间戳业务代码加密后的消息体名称说明数据类型长度（字节）CODE消息标志：registerString32SID消息序列号，与请求消息同值Long-TIMESTAMP系统时间戳：YYYYMMDDHHmmssnnnnString24SERVICEID业务代码String32未加密的消息体格式消息体格式返回结果代码返回结果消息描述周期同步是否修改下一次同步周期 邮件上报周期 公告上报周期 名称说明数据类型长度（字节）RESULTCODE返回结果代码0：成功；-1：失败； int-RESULTMSG返回结果消息描述String512SYNCSTATUS同步周期是否发生变化0：无变化；1：有变化；Int-SYNCINFO下一次同步周期list可选周期选项参数代码参数说明MAIL邮件NOTICE公告4.1.2 工作流接口4.1.3 通知公告