山西证券用户管理中心接口规范.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) URLhttp:/IP /sxzq_asm/api/user/dl/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码(登陆账号)pass必须string密码(此密码由用户管理中心统一生成,用短信发送给客户)6) 请求示例3/sxzq_asm/ api/user/dl/cpbh/11111111/type/2/rtntype/2/sjhmpass/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:SJHMYHLX:1,SFSD:1,QX:0,sfgq:1,custid:,department:,branchno:,accountno:, custdistin:, bear:, risk:XML格式100001155273284361109) 错误的返回结果rtnno:100002,rs:JSON格式100002XML格式2. 注册与修改密码1) URLhttp:/IP /sxzq_asm/api/user/zcyzgmm/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码(登陆账号)6) 请求示例3/sxzq_asm/ api/user/zcyxgmm/cpbh/11111111/type/2/rtntype/2/sjhm返回参数说明参数名称描述rtnno返回码,请参考返回码表pass系统生成的明文密码7) 正确的返回结果JSON格式rtnno:100101,rs:pass:123456100101 123456XML格式8) 错误的返回结果rtnno:100102,rs:JSON格式XML格式1001023. 添加自选代码1) URLhttp:/IP /sxzq_asm/api/user/tjzxdm/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码(登陆账号)dm必须string代码dmlx必须string代码类型(SZ-深市,SH-沪市,JJ-基金,CP-理财产品,HK-港股,QH-期货)6) 请求示例3/sxzq_asm/ api/user/tjzxdm/cpbh/11111111/type/2/rtntype/2/sjhmdm/000001/dmlx/SZ/7) 返回参数说明参数名称描述rtnno返回码,请参考返回码表8) 正确的返回结果JSON格式rtnno:100201,rs:100201XML格式9) 错误的返回结果rtnno:100202,rs:JSON格式XML格式1002024. 删除自选代码1) URLhttp:/IP /sxzq_asm/api/user/sczxdm/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码(登陆账号)dm必须string代码dmlx必须string代码类型(SZ-深市,SH-沪市,JJ-基金,CP-理财产品,HK-港股,QH-期货)6) 请求示例3/sxzq_asm/ api/user/sczxdm/cpbh/11111111/type/2/rtntype/2/sjhmdm/000001/dmlx/SZ/7) 返回参数说明参数名称描述rtnno返回码,请参考返回码表8) 正确的返回结果JSON格式rtnno:100203,rs:100203XML格式9) 错误的返回结果rtnno:100204,rs:JSON格式XML格式1002045. 返回自选代码列表1) URLhttp:/IP /sxzq_asm/api/user/zxdmlb/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码(登陆账号)6) 请求示例3/sxzq_asm/ api/user/zxdmlb/cpbh/11111111/type/2/rtntype/2/sjhm7) 返回参数说明参数名称描述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:SH100205000001SZ000002SZ600000HSXML格式9) 错误的返回结果rtnno:100206,rs:JSON格式XML格式1002066. 定制产品1) URLhttp:/IP /sxzq_asm/api/user/dzcp/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码dzcpbh必须string需要定制的产品编号6) 请求示例3/sxzq_asm/ api/user/dzcp/cpbh/11111111/type/2/rtntype/2/sjhm7) 返回参数说明参数名称描述rtnno返回码,请参考返回码表8) 正确的返回结果JSON格式rtnno:100301,rs:100301XML格式9) 错误的返回结果rtnno:100302,rs:JSON格式XML格式1003027. 退订产品1) URLhttp:/IP /sxzq_asm/api/user/dzcp/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码tdcpbh必须string需要退订的产品编号6) 请求示例3/sxzq_asm/ api/user/dzcp/cpbh/11111111/type/2/rtntype/2/sjhm7) 返回参数说明参数名称描述rtnno返回码,请参考返回码表8) 正确的返回结果JSON格式rtnno:100303,rs:100303XML格式9) 错误的返回结果rtnno:100304,rs:JSON格式XML格式1003048. 用户提升1) URLhttp:/IP /sxzq_asm/api/user/yhts/本Internal API的测试IP为：3，正式IP待定；2) 返回格式XML和JSON3) HTTP请求方式POST,GET4) IP限制TRUE5) 传入参数说明参数名称是否必须类型描述cpbh必须string产品编号type必须int调用类型,接口调用必须为2；rtntype必须int返回数据格式类型(1代表返回JSON;2代表返回XML)sjhm必须string手机号码khbh必须int客户编号6) 请求示例3/sxzq_asm/ api/user/yhts/cpbh/11111111/type/2/rtntype/2/sjhmkhbh/111117) 返回参数说明参数名称描述rtnno返回码,请参考返回码表8) 正确的返回结果JSON格式rtnno:100401,rs:100401XML格式9) 错误的返回结果rtnno:100402,rs:JSON格式XML格式1004029. 返回码码表返回码描述系统返回码中文说明(0 - 100000)0未知错误1非法请求2系统错误3产品编码为空4产品编码不存在5产品编码不合法6系统非法请求(指服务器IP匹配失败)7操作成功用户登录返回码中文解释(100001 - 100100)100001登录成功100002登录失败100011手机号码为空100012手机号码不合法100021密码为空100022密码错误100031账户被锁定用户注册修改密码返回码中文说明(100101 - 100200)100101用