山西证券用户管理中心接口规范.doc

山西证券用户管理中心接口规范
一、 业务级Internal API

功能分类
功能名称
接口
功能描述
用户
登录验证
/sxzq_asm/api/user/dl/
获取用户的基本信息,包括手机号码、用户类型、是否锁定、是否有权限、客户编号、部门编号、营业部编号、资金账号、客户级别、风险承受能力、账户风险度、是否过期；
注册与修改密码
/sxzq_asm/api/user/zcyxgmm/
新用户使用手机号码即可注册,同时本接口完成密码修改功能,两者都会将密码用短信方式发送给手机用户，同时以明文形式返回给调用的系统；
自选代码
添加
/sxzq_asm/api/user/tjzxdm/
使用手机号码做为用户的标识,添加自选代码(包括股票、基金)；
删除
/sxzq_asm/api/user/sczxdm/
使用手机号码做为用户的标识,删除自选代码(包括股票、基金)；
自选代码列表
/sxzq_asm/api/user/zxdmlb/
使用手机号码做为用户的标识,获取自选代码列表(包括股票、基金)；
产品
定制产品
/sxzq_asm/api/user/dzcp/
使用手机号码做为用户的标识,传入需要定制的产品编号,即可定制；
退订产品
/sxzq_asm/api/user/tdcp/
使用手机号码做为用户的标识,传入需要退订的产品编号,即可退订；
用户提升
用户提升
/sxzq_asm/api/user/yhts/
用与绑定用户的手机号码和客户编号。
二、 接口详细使用说明
1. 登录验证
1) URL
http://[IP] /sxzq_asm/api/user/dl/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明
参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码(登陆账号)
pass
必须
string
密码(此密码由用户管理中心统一生成,用短信发送给客户)
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/dl/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/pass/123456/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表
sjhm
手机号码
yhlx
用户类型(1非山西证券开户的客户,2山西证券开户的客户)
sfsd
是否锁定(1正常,其它锁定)
qx
是否有权限(0无权限,1有权限)
sfgq
是否过期(0过期,1未过期)
custid
客户编号
department
部门编号
branchno
营业部编号
accountno
资金账号
custdistin
客户级别(1:一级贵宾;2:二级贵宾;3:三级贵宾;4:四级贵宾;5:普通客户)
bear
风险承受能力(0:默认型;1:保守;2:稳健;3:平衡;4:积极;5:激进)
risk
账户风险度(1:正常;2:关注;3:一般关注;4:重点关注;5:交易监控)

8) 正确的返回结果
JSON格式
{"rtnno":100001,"rs":{"SJHM":"15527328436","YHLX":"1","SFSD":"1","QX":"0","sfgq":"1","custid":"","department":"","branchno":"","accountno":""," custdistin":""," bear":""," risk":""}}

XML格式
<sxzq id='sxzq'>
<rtnno>100001</rtnno>
<rs>
<sjhm>15527328436</sjhm>
<yhlx>1</yhlx>
<sfsd>1</sfsd>
<qx>0</qx>
<custid></custid>
<department></department>
<branchno></branchno>
<accountno></accountno >
< custdistin></ custdistin>
< bear></bear>
< risk></risk>
</rs>
</sxzq>

9) 错误的返回结果
{"rtnno":100002,"rs":{}}
JSON格式

<sxzq id='sxzq'>
<rtnno>100002</rtnno>
<rs>
</rs>
</sxzq>
XML格式

2. 注册与修改密码
1) URL
http://[IP] /sxzq_asm/api/user/zcyzgmm/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码(登陆账号)
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/zcyxgmm/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/
返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表
pass
系统生成的明文密码

7) 正确的返回结果
JSON格式
{"rtnno":100101,"rs":{"pass":"123456"}}

<sxzq id='sxzq'>
<rtnno>100101</rtnno>
<rs>
<pass>123456</pass>
</rs>
</sxzq>
XML格式

8) 错误的返回结果
{"rtnno":100102,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100102</rtnno>
<rs>
</rs>
</sxzq>

3. 添加自选代码
1) URL
http://[IP] /sxzq_asm/api/user/tjzxdm/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码(登陆账号)
dm
必须
string
代码
dmlx
必须
string
代码类型(SZ-深市,SH-沪市,JJ-基金,CP-理财产品,HK-港股,QH-期货)
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/tjzxdm/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/dm/000001/dmlx/SZ/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表

8) 正确的返回结果
JSON格式
{"rtnno":100201,"rs":{}}

<sxzq id='sxzq'>
<rtnno>100201</rtnno>
<rs>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100202,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100202</rtnno>
<rs>
</rs>
</sxzq>

4. 删除自选代码
1) URL
http://[IP] /sxzq_asm/api/user/sczxdm/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码(登陆账号)
dm
必须
string
代码
dmlx
必须
string
代码类型(SZ-深市,SH-沪市,JJ-基金,CP-理财产品,HK-港股,QH-期货)
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/sczxdm/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/dm/000001/dmlx/SZ/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表

8) 正确的返回结果
JSON格式
{"rtnno":100203,"rs":{}}

<sxzq id='sxzq'>
<rtnno>100203</rtnno>
<rs>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100204,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100204</rtnno>
<rs>
</rs>
</sxzq>

5. 返回自选代码列表
1) URL
http://[IP] /sxzq_asm/api/user/zxdmlb/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码(登陆账号)
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/zxdmlb/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表
dm
代码
dmlx
代码类型(SZ-深市,SH-沪市,JJ-基金,CP-理财产品,HK-港股,QH-期货)

8) 正确的返回结果
JSON格式
{"rtnno":100205,"rs":[{"dm":"000001","dmlx":"SZ"},{"dm":"000002","dmlx":"SZ"},{"dm":"600000","dmlx":"SH"}]}

<?xml version='1.0' encoding='UTF-8'?>
<sxzq id='sxzq'>
<rtnno>100205</rtnno>
<rs>
<r0><DM>000001</DM><DMLX>SZ</DMLX></r0>
<r1><DM>000002</DM><DMLX>SZ</DMLX></r1>
<r2><DM>600000</DM><DMLX>HS</DMLX></r2>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100206,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100206</rtnno>
<rs>
</rs>
</sxzq>

6. 定制产品
1) URL
http://[IP] /sxzq_asm/api/user/dzcp/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码
dzcpbh
必须
string
需要定制的产品编号
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/dzcp/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表

8) 正确的返回结果
JSON格式
{"rtnno":100301,"rs":[]}

<?xml version='1.0' encoding='UTF-8'?>
<sxzq id='sxzq'>
<rtnno>100301</rtnno>
<rs>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100302,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100302</rtnno>
<rs>
</rs>
</sxzq>

7. 退订产品
1) URL
http://[IP] /sxzq_asm/api/user/dzcp/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码
tdcpbh
必须
string
需要退订的产品编号
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/dzcp/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表

8) 正确的返回结果
JSON格式
{"rtnno":100303,"rs":[]}

<?xml version='1.0' encoding='UTF-8'?>
<sxzq id='sxzq'>
<rtnno>100303</rtnno>
<rs>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100304,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100304</rtnno>
<rs>
</rs>
</sxzq>

8. 用户提升
1) URL
http://[IP] /sxzq_asm/api/user/yhts/
本Internal API的测试IP为：202.99.197.83，正式IP待定；
2) 返回格式
XML和JSON
3) HTTP请求方式
POST,GET
4) IP限制
TRUE
5) 传入参数说明

参数名称
是否必须
类型
描述
cpbh
必须
string
产品编号
type
必须
int
调用类型,接口调用必须为2；
rtntype
必须
int
返回数据格式类型(1代表返回JSON;2代表返回XML)
sjhm
必须
string
手机号码
khbh
必须
int
客户编号
6) 请求示例
http://202.99.197.83/sxzq_asm/ api/user/yhts/cpbh/11111111/type/2/rtntype/2/sjhm/15527328436/khbh/11111
7) 返回参数说明
参数名称
描述
rtnno
返回码,请参考返回码表

8) 正确的返回结果
JSON格式
{"rtnno":100401,"rs":[]}

<?xml version='1.0' encoding='UTF-8'?>
<sxzq id='sxzq'>
<rtnno>100401</rtnno>
<rs>
</rs>
</sxzq>
XML格式

9) 错误的返回结果
{"rtnno":100402,"rs":{}}
JSON格式

XML格式
<sxzq id='sxzq'>
<rtnno>100402</rtnno>
<rs>
</rs>
</sxzq>

9. 返回码码表
返回码
描述
系统返回码中文说明(0 - 100000)
0
未知错误
1
非法请求
2
系统错误
3
产品编码为空
4
产品编码不存在
5
产品编码不合法
6
系统非法请求(指服务器IP匹配失败)
7
操作成功

用户登录返回码中文解释(100001 - 100100)
100001
登录成功
100002
登录失败
100011
手机号码为空
100012
手机号码不合法
100021
密码为空
100022
密码错误
100031
账户被锁定

用户注册修改密码返回码中文说明(100101 - 100200)
100101
用户注册成功
100102
用户注册失败
100103
修改密码成功
100104
修改密码失败
100111
用户手机号码为空
100112
用户手机号码不合法
100113
用户手机号码存在

自选代码返回码中文说明(100201 - 100300)
100201
添加自选成功
100202
添加自选失败
100203
删除自选成功
100204
删除自选失败
100205
返回自选代码成功
100206
返回自选代码失败
100211
用户手机号码为空
100212
用户手机号码不合法
100213
用户手机号码不存在
100221
代码为空
100222
代码不合法
100223
代码不存在
100224
代码存在
100231
代码类型为空
100232
代码类型不合法
100241
自选代码超过100

产品定制退订返回码中文说明(100301 - 100400)
100301
定制产品成功
100302
定制产品失败
100303
退订产品成功
100304
退订产品失败
100311
用户手机号码为空
100312
用户手机号码不合法
100313
用户手机号码不存在
100321
定制产品编号为空
100322
定制产品编号不合法
100323
定制产品编号不存在
100324
产品已经定制
100325
产品还没有定制

用户提升(100401-100500)
100401
提升成功
100402
提升失败
100411
手机号码为空
100412
手机号码不合法
100413
手机号码不存在
100421
客户编号为空
100422
客户编号不合法