CWPS 通行证系统外部访问接口
上海蓝慕信息科技有限公司(http://www.lonmo.com)
1
CWPS 通行证系统外部访问接口
2007 年 8 月 30 日
CWPS 通行证系统外部访问接口
上海蓝慕信息科技有限公司(http://www.lonmo.com)
2
所有权声明
本文档的内容将做定期性的变动,且不另行通知。更改的内容将会补充到本手册中。
除特别声明外,此文档所用的公司名称、个人姓名及数据均属为说明的目的而模拟。
本文档的版权属上海蓝慕信息科技有限公司(本公司)所有,受中华人民共和国法律的
保护。
本文档所含的任何构思、设计、工艺及其他技术信息均属本公司所有,受中华人民共和
国法律的保护。未经本公司书面同意,任何单位和个人不得擅自摘抄、全部或部分复制本书
内容,或者以其他任何方式使第三方知悉。
CMSware™系上海蓝慕信息科技有限公司所有,不得仿冒。
版本号:1.1
相关术语与缩略语解释
CWPS Center Web Passport System, 中央Web通行系统
OAS Outer Application System 外部应用系统
SSO Single Sign On,单点登录
XML eXtensible Markup Language,可扩展标记语言
Session 是指HTTP 访问过程中的一个完整会话过程
SOAP 简单对象访问协议
前言....................................................................................................................................................4
CWPS 通行证系统外部访问接口
上海蓝慕信息科技有限公司(http://www.lonmo.com)
3
第一章 数据处理流程描述....................................................................................................4
第二章 接口消息定义............................................................................................................4
1.接口请求消息公共字段定义(ActionReq).............................................................................5
2.接口应答消息公共字段定义(ActionResp) ...........................................................................5
3.接口消息定义.........................................................................................................................5
3.1 会员登陆接口消息定义..............................................................................................5
3.1.1 功能描述...........................................................................................................5
3.1.2 接口内容描述...................................................................................................6
ActionReq 消息字段描述 .................................................................................6
ActioResp 消息字段描述..................................................................................6
3.2 会员登出接口消息定义..............................................................................................8
3.2.1 功能描述...........................................................................................................8
3.2.2 接口内容描述...................................................................................................8
ActionReq 消息字段描述 .................................................................................8
ActioResp 消息字段描述..................................................................................8
3.2 会员注册接口消息定义..............................................................................................8
3.2.1 功能描述...........................................................................................................8
3.2.2 接口内容描述...................................................................................................8
ActionReq 消息字段描述 .................................................................................8
ActioResp 消息字段描述..................................................................................9
第三章 接口开发规范......................................................................................................................9
CWPS 端开发规范....................................................................................................................9
CWPS 端系统结构..........................................................................................................10
CWPS 外部访问接口开发流程......................................................................................10
OAS 端开发规范.....................................................................................................................11
OAS 端开发流程(PHP) .............................................................................................11
第四章 页面访问接口....................................................................................................................13
功能描述..................................................................................................................................13
接口定义..................................................................................................................................13
用户登陆 Login...............................................................................................................13
流程图......................................................................................................................13
检测用户登陆 IsLogin ....................................................................................................16
第四章 附录 返回值定义..............................................................................................................17
第五章 SOAP 类常量定义 ............................................................................................................17
CWPS 通行证系统外部访问接口
上海蓝慕信息科技有限公司(http://www.lonmo.com)
4
前言
第一章 数据处理流程描述
第二章 接口消息定义
消息名
消息类型
消息方向
ActionReq
Request
OAS->CWPS
ActionResp
Response
CWPS->OAS
1.接口请求消息公共字段定义(ActionReq)
字段名
重要性
类型
说明
TransactionID
必须
string
该消息的编号
Version
必须
string
该接口消息的版本号,
当前统一为 1.1
TransactionAccessKe
y
必须
String
接口访问密码,用于
验证 OAS 请求的有
效性
Action
必须
string
请求访问的接口名
CWPS 通行证系统外部访问接口
上海蓝慕信息科技有限公司(http://www.lonmo.com)
5
Params
必须
包含子元素
访问接口所传递的参
数
ReqCharset
可选(1.1 新增)
String
OAS 发起 ActionReq
的 数 据 编 码 , 比 如
gb2312 、utf8 ,默认
使用 utf8 编码, 要使
用 此 设 置 , 目 标
CWPS 必须安装在
MySQL4.1 以上版本
的数据库上
RespCharset
可选(1.1 新增)
String
OAS 端 可 以 请 求
CWPS 的 ActionResp
返回 RespCharset 设
置的数据编码,比如
gb2312、utf8,默认使
用 utf8 编码, 要使用
此设置,目标 CWPS
必 须 安 装 在
MySQL4.1 以上版本
的数据库上
2.接口应答消息公共字段定义(ActionResp)
字段名
重要性
类型
说明
TransactionID
必须
string
该消息的编号
Version
必须
string
该接口消息的版本号,
当前统一为 1.1
hRet
必须
string
返回值,详细定义见
第 4 章
FeatureStr
string
返回消息应答字符串
Return
必须
包含子元素
返回的数据
RespCharset
可选(1.1 新增)
String
CWPS 应 答
ActionResp 的数据编
码,比如 gb2312、utf8,
默认使用 utf8 编码