ADC平台与SI应用系统接口说明书V23.docx

ADC平台与SI应用系统接口说明书V23.docx

《ADC平台与SI应用系统接口说明书V23.docx》由会员分享，可在线阅读，更多相关《ADC平台与SI应用系统接口说明书V23.docx（83页珍藏版）》请在冰豆网上搜索。

ADC平台与SI应用系统接口说明书V23

产品名称Productname

密级Confidentialitylevel

ADC平台与SI应用系统接口规范

机密

产品版本Productversion

Total63pages共63页

V2.2

ADC平台与SI应用系统接口规范

Preparedby

拟制

闫红宾李大锋

Date

日期

2006-9-9

Reviewedby

评审人

Date

日期

Approvedby

批准

Date

日期

yyyy-mm-dd

Authorizedby

签发

Date

日期

yyyy-mm-dd

HuaweiTechnologiesCo.,Ltd.

华为技术有限公司

Allrightsreserved

版权所有XX

（REP01T01V2.4/IPD-CMMV3.0/forinternaluseonly）

（REP01T01V2.4/IPD-CMMV3.0/仅供内部使用）

RevisionRecord修订记录

Date

日期

Revision

Version

修订版本

ChangeDescription

修改描述

Author

作者

2006-4-13

1.0

初稿

闫红宾

2006-4-27

1.0

第一次修改

闫红宾

2006-5-27

1.0

第二次修改

李大锋

2006-7-12

1.0

第三次修改

戴学锋

2006-9-9

1.01

第四次修改，针对格式细节进行详细解释。

增加附录三、四，SOAP官方规范和WSDL官方规范

戴学锋

2006-9-20

1.02

增加附录五，消息打包解包java类及说明

戴学锋

2006-9-20

1.03

增加附录五，消息打包解包示例工程

李大锋

2006-11-8

1.04

增加部门信息绑定接口，员工绑定可选参数列表增加部门编号

闫红宾

李大锋

2006-12-1

1.2

增加获取密码、业务统计信息上报、业务监控信息上报接口，调整企业绑定、部门绑定、员工绑定接口消息体风格。

闫红宾

2006-12-6

1.2

修改接口：

获取帐号接口、业务统计信息报告接口、业务监控信息报告接口，修改EAA模型。

戴红毅

2006-12-12

1.3

删除登陆接口，调整消息风格

闫红宾

2007-1-8

1.3

增加登陆接口

戴红毅

2007-2-10

1.4

登陆接口增加TOKEN字段

窦兴权

2007-2-12

1.5

修改错别字

窦兴权

2007-3-1

1.6

更换WSDL文件；

补充业务统计中的起始统计时间、截止统计时间的格式和业务监控中起始监控时间、截止监控时间的格式；

李锦清

2007-3-5

1.7

修改鉴权接口、统计信息报告接口、业务监控信息报告接口的ASPID字段的注释（从应用提供商ID改为应用提供商Account）

李锦清

2007-3-6

1.8

补充原1.2版新增的下行短信接口、获取帐号接口、上发短信接口（1.2后面的版本没有把这三个新增接口合进来）

李锦清

2007-4-19

1.81

修改Login接口，增加了登录企业编号

张燕斌

2007-4-20

1.82

修改员工绑定接口，增加了终端类型

张燕斌

2007-4-20

1.83

去掉了座机类型，传真类型，邮箱类型

张燕斌

2007-5-8

1.84

扩展企业帐号邦定、部门邦定、员工帐号邦定的消息返回码的定义；员工帐号绑定中的USERTYPE增加定义内容2：

企业通讯录。

闫红宾

2007-6-28

1.85

增加员工帐号绑定接口中后台自动同步的业务参数，业务用户编号和功能点ID；补充EC、DEPT、STAFF扩展属性字段的长度

闫红宾

陈少兵

2007-7-5

2.0

按照集团公司规范修订：

1、更新鉴权响应结果代码；2、更新SSO心跳响应结果代码；3修改CorpBindReq接口中功能点的表示方法；4变更CorpBindReq接口中LICENSE、OPTYPE、OPNOTE字段的位置；5更新CorpBindReq接口中OPTYPE字段的内容；6更新CorpBindRsp中响应代码；

闫红宾

2007-7-22

2.1

增加企业邦定确认接口和员工邦定确认接口；在业务的URL中增加定购关系编号的传递；

闫红宾

2007-9-28

2.2

增加SI到ADC的用户信息同步接口

闫红宾

Catalog目录

1

总体概述

1.1起草单位

本文档的起草单位为华为技术有限公司。

1.2说明

为了帮助SI开发可接入ADC平台的应用，特制定本规范。

本规范规定了SI系统与ADC平台之间的应用层的接口及协议。

规范说明了在开通、使用中小企业信息化应用业务过程中ADC平台与SI系统交互的流程，并对流程中涉及的接口进行了定义。

本规范用于指导SI业务系统与ADC平台接口的实现，SI向ADC平台发起和接收请求的接口都应遵从该规范。

1.3名词解释

1.3.1ADC

ADC：

ApplicationDataCenter（应用数据中心），ADC是华为公司为运营商提供的中小企业信息化平台产品，即ADC平台。

1.3.2SI系统

SI：

ServiceIntegrator（应用服务集成商），运营商的主要合作伙伴之一，可以提供各种类型的企业信息化的产品及方案，具有成熟的产品及技术能力。

1.3.3业务/业务集（套餐）

业务是指由SI提供的，供企业定购的应用服务。

每个应用服务都可以拥有各种属性。

多个业务打包销售，形成业务套餐，业务和套餐之间是多对多关系，一个业务可以属于多个套餐，一个套餐包含多个业务。

业务（集）发布在ADC平台上以后，ADC平台省级管理员审核后，由ADC平台的省级管理员设置资费，分公司管理员作其他定义后成为可以对企业销售的产品，方可在ADC平台内进行推介和销售，这时才可以被企业选择定购。

1.3.4用户

用户指具体使用ADC平台的企业的员工和企业的客户。

用户有管理员和一般用户之分，管理员分为系统管理员，运营商管理员，客户经理和企业管理员。

只有管理员可以为企业订购或变更定购的业务（集）。

1.3.5企业帐号

企业帐号是其在系统内对外显示的唯一标识，所有的业务受理、使用等通过该帐号进行。

一个企业只对应一个企业帐号。

一个企业帐号可以拥有多个用户帐号。

企业帐号要保证全局的唯一性。

1.3.6登陆帐号

用户帐号由企业管理员配置，用户帐号在企业帐号内唯一，用户登录系统时使用userAccount@corpDomain作为用户名进行登录。

userAccount是用户的帐号，corpDomain是企业的域名，企业域名与企业帐号一一对应，可用企业品牌的缩写表示。

1.3.7SSO单点登陆

用户只要通过ADC平台的认证，即可自由地访问SI提供的付费服务，而不需要再次输入SI系统的认证信息；通过SI与ADC平台之间的通讯，SI系统确保该用户是合法用户，从而提供应用服务，实现单点登陆，全网应用。

1.3.8ME

ME（MessageEngine）：

ADC平台提供的统一消息引擎。

对于需要短信功能的业务系统，ADC平台可以提供该能力接口

1.3.9EAA

EAA（EnterpriseApplicationAgent）：

企业应用代理。

ADC平台与SI系统进行交互的统一应用服务代理。

2ADC平台与SI系统接口定位

3ADC平台与SI系统接口协议

3.1基本协议

双方的消息交互采用SOAP（SimpleObjectAccessProtocol，简单对象访问协议）接口。

这是一个可以运行在任何传输协议上的轻量级协议，它包含三个方面：

XML-envelop为描述信息内容和如何处理内容定义了框架；将程序对象编码成为XML对象的规则；执行远程调用（RPC，RemoteProcedureCall）的约定。

本文描述的接口都承载于HTTP协议之上。

3.2接口描述

我们用WSDL（WebServicesDescriptionLanguage）来对接口进行描述。

WSDL是用来定义Web服务的属性以及如何调用它的一种XML语言。

一个完整的WSDL服务描述是由一个服务接口和一个服务实现文档组成的。

通过查阅Web服务的WSDL文档，开发者可以知道Web提供了哪些方法和如何用正确的参数调用他们。

因为WSDL包含了对服务接口的完整描述，所以我们可以使用它来创建能简化服务访问的存根，该存根为一段Java代码（假设使用Java），它自动生成了访问Web服务的类。

如果我们需要访问Web服务，只需调用该类中对应的方法即可，而不用在客户端程序中再写入配置信息。

3.3消息格式

本文所描述的所有消息，都基于下图所示的层次进行封装：

以下是企业绑定消息进行封装后的完整数据示例：

POST/IfAPServiceHTTP/1.0

Content-Type:

text/xml;charset=utf-8

Accept:

application/soap+xml,application/dime,multipart/related,text/*

Host:

218.201.45.17:

8686

Cache-Control:

no-cache

Pragma:

no-cache

SOAPAction:

""

Content-Length:

1517

Envelopexmlns:

soapenv="http:

//schemas.xmlsoap.org/soap/envelope/"

xmlns:

xsd="http:

//www.w3.org/2001/XMLSchema"

xmlns:

xsi="http:

//www.w3.org/2001/XMLSchema-instance">

Body>

corpBindingsoapenv:

encodingStyle="http:

//schemas.xmlsoap.org/soap/encoding/"

xmlns:

ns1="">

type="soapenc:

string"xmlns:

soapenc="http:

//schemas.xmlsoap.org/soap/encoding/">

协议数据单元PDU

corpBinding>

Body>

Envelope>

所有的协议数据单元PDU都是xml格式的字符串，由如下表的消息头和消息体组成：

PDU组成

描述

MessageHeader

消息头

MessageBody

消息体

消息头和消息体在xml中的表现形式如下：

xmlversion="1.0"encoding="UTF-8"?

>

消息头属性一

消息头属性二

消息头属性三

加密后的消息体

未加密的消息体也是一个的完整的xml文件，如下例所示：

xmlversion="1.0"encoding="UTF-8"?

>

消息体属性一

消息体属性二

消息体属性三

消息体的加密算法为：

Base64（DES（MD5（消息体）+消息体））。

在第4章节中对消息格式的描述，都是指对协议数据单元的描述。

3.4消息完整性

数字签名使用强大的加密技术和公钥基础结构，以更好地保证文档的真实性、完整性和受认可性。

数字签名可以提供端到端的消息完整性保证，可以提供有关消息发件人的验证信息，可以在最终使用和处理消息时对签名进行验证。

数字签名对消息内容提供完整性检查，如果原始内容的某个字节已经被修改，那么签名验证将失败。

数字签名算法：

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-ECB

4．经过DES加密后的数据必须通过Base64编码转换为明文的字符串

3.6接口调用方法（java实现）

1．假设提供soap接口的服务端地址为”http:

//10.0.0.100:

8088/IfSoapDemo”

2．访问WEB地址”http:

//10.0.0.100:

8088/IfSoapDemo?

wsdl”获得wsdl文档

3．假定文档中说明该调用接口的类方法Stringdo（Stringsmg）

4．Java中调用该接口的简单示例代码如下：

try{

Stringendpoint="http:

//10.0.0.100:

8088/IfSoapDemo";

org.apache.axis.client.Serviceservice=neworg.apache.axis.client.Service（）;

org.apache.axis.client.Callcall=null;

call=（org.apache.axis.client.Call）service.createCall（）;

call.setOperationName（newjavax.xml.namespace.QName（endpoint,"do"））;

call.setTargetEndpointAddress（new.URL（endpoint））;

Stringsmg=“testParameter”;

Stringret=（String）call.invoke（newObject[]{smg}）;

}

catch（ServiceExceptionex）

{

ex.printStackTrace（）;

}

5．用JBuilder等集成开发环境可以更加方便的生成相关调用代码。

4ADC平台与SI系统接口描述

4.1ADC提供给SI系统的接口

4.1.1鉴权接口

用户登陆到ADC后，系统为用户分配一个Token，当用户点击业务系统链接登陆到业务系统时，ADC将会把用户Token传递给业务系统，然后业务系统再调用ADC提供的鉴权接口获取用户访问权限，包括用户的类型和操作权限。

Token传递的方式：

参数和POST-----采用URL中的参数方式，参数名称是：

token。

当管理员从EUMP登陆ADC后访问SI业务时，ADC只传递用户Token，不传递用户编号：

即：

?

token=xxxxxxx

此时，SI系统需要提供该企业定购该业务的多个定购关系的管理界面；（管理员没有定购关系）。

当用户从EUAP登陆ADC后访问SI业务时，ADC传递Token和用户编号：

即：

?

token=xxxxxxx&subscriberID=****。

此时，SI系统需要直接提供该用户相应的定购关系的使用界面；

Token发送采用明文。

ADC平台单点登录流程如下：

1．用户输入帐号和密码登录到ADC平台，ADC平台为用户产生Token；

2．用户点击SI应用系统链接，ADC平台将用户Token发送给SI应用系统；

3．SI应用系统请求ADC平台对用户Token鉴权；

4．ADC平台返回鉴权响应，将Token对应的用户信息和用户权限信息发送给SI应用系统。

AuthenReq鉴权请求消息

参数标识

AuthenReq

消息格式

xmlversion="1.0"encoding="UTF-8"?

>

消息标志

消息序列号

时间戳

业务代码

加密后的消息体

名称

说明

数据类型

长度（字节）

CODE

消息标志：

Authen

String

32

SID

消息序列号，自行生成

Long

--

TIMESTAMP

系统时间戳：

YYYMMDDHHmmssnnnn

String

24

SERVICEID

业务代码

String

32

未加密的消息体格式

消息体格式

xmlversion="1.0"encoding="UTF-8"?

>

应用提供商Account

令牌

请求地址

名称

说明

数据类型

长度（字节）

ASPID

应用提供商Account

String

32

TOKEN

令牌

String

64

ACTION

请求地址

String

512

AuthenRsp鉴权响应消息

参数标识

AuthenRsp

消息格式

xmlversion="1.0"encoding="UTF-8"?

>

消息标志

消息序列号

时间戳

业务代码

加密后的消息体

名称

说明

数据类型

长度（字节）

CODE

消息标志：

Authen

String

32

SID

消息序列号，与请求消息同值

Long

--

TIMESTAMP

系统时间戳：

YYYYMMDDHHmmssnnnn

String

24

SERVICEID

业务代码

String

32

未加密的消息体格式

消息体格式

xmlversion="1.0"encoding="UTF-8"?

>

返回结果代码

返回结果消息描述

企业帐号

用户ID

用户类型

鉴权消息内容

操作项ID

操作项名称

操作项对应的URL地址

名称

说明

数据类型

长度（字节）

RESULTCODE

返回结果代码

0成功;1对未定义错误的描述;101数据非法加密;102用户Token已失效;103用户Token不存在;104用户登录未知系统

int

--

RESULTMSG

返回结果消息描述

String

512

CORPACCOUNT

企业帐号

String

32

UFID

用户ID

String

32

USERTYPE

用户类型：

用户在业务系统中的角色。

（0表示企业管理员1表示企业用户）

String

16

ACTIONID

操作项ID

String

16

ACTIONNAME

操作项名称

String

32

ACTIONURL

操作项对应的URL地址

String

128

4.1.2SSO心跳接口

为实现用户的单点登陆，ADC平台必须时刻感知到用户当前是否处于存活状态。

用户登陆到业务系统以后，ADC平台无法确定用户是否在线，默认情况下，ADC平台30分钟后，将会自动取消用户的会话。

所以业务系统必须定时（缺省5分钟，不要小于5分钟，也不要大于10分钟）调用该接口通知ADC平台更新用户Token的生命周期。

PulseReq心跳请求消息

参数标识

Pulse

消息格式

xmlversion="1.0"encoding="UTF-8"?

>

消息标志

消息序列号

时间戳

业务代码

加密后的消息体

名称

说明

数据类型

长度（字节）

CODE

消息标志：

Pulse

String

32

SID

消息序列号，自行生成

Long

--

TIMESTAMP

系统时间戳：

YYYMMDDHHmmssnnnn

String

24

SERVICEID

业务代码

String

32

未加密的消息体格式

消息体格式

xmlversion="1.0"encoding="UTF-8"?

>

令牌

名称

说明

数据类型

长度（字节）

TOKEN

令牌

String

64

PulseRsp心跳响应消息

参数标识

PulseRsp

消息格式

xmlversion="1.0"encoding="UTF-8"?

>

消息标志

消息序列号

时间戳

业务代码

加密后的消息体

名称

说明

数据类型

长度（字节）

CODE

消息标志：

Pulse

String

32

SID

消息序列号：

与请求消息同值

Long

--

TIMESTAMP

系统时间戳YYYYMMDDHHmmssnnnn

String

24

SERVICEID

业务代码

String

32

未加密的消息体格式

消息体格式

xmlversion