颂大录取分析系统接口规范.docxVIP

颂大录取分析系统接口规范Version：1.01、引言1.1编写目的约定第三方用户访问录取分析系统服务的方式。1.2阅读对象合作伙伴的技术开发人员，维护人员及管理人员。1.3术语定义术语术语解释2、介绍2.1密钥申请用本系统提供：appKey和appSecret；用户需提供：公司代码，访问接口应用代码；调用接口时作为请求参数，颂大会根据传入的appKey和appSecret校验，若不正确则不予访问。2.2访问方式系统对外提供webservice接口，用户通过发送soap请求调用系统服务。2.3签名算法为了防止传递的请求参数被篡改，访问接口时需提供参数签名。签名算法描述如下：(1) 将所有参数（key-value）按照key升序将value拼接在一起；(2) 将1的结果的首尾加上appSecret值，例如：appSecretvalue1value2appSecret(3) 将2的结果进行MD5大写加密。假设，user.logon 的服务有 2 个业务级参数，分别为 userName、password。这些业务 级参数和系统级参数的值如下表所示：系统级参数名称参数值业务级参数名称参数值appKey000001userNametomsonmethoduser.logonpasswrod123456v1.0messageFormatjson服务参数列表将参数（key-value）按照key升序将value拼接在一起：000001jsonuser.logon123456tomson1.0 假设，appKey 为 000001 的 appSecret（应用密钥）是“abcdef”，则将“abcdef”分别添加到以上请求参数串的头部和尾部，得到： abcdef000001jsonuser.logon123456tomson1.0abcdef 对以上字符串进行MD5加密，并转为大写，得到： 8C07B49FFC57B538A4136F86A445E8BD 2.4访问限制2.5接口地址请求地址：/webservice/fxInterfaceService?wsdl 测试地址：09:8080/zkzz_src/webservice/fxInterfaceService?wsdl接口描述3.1 概述数据分析系统向外围系统提供服务，其中包括录取概率预测、往年各校录取分数统计和往年个地区分数段统计。3.2 参数、返回值系统目前统一接收json字符串参数，并把处理结果通过json字符串返回给调用者。通用参数约定：appKey:FX0001appSecret:60EC23296DE14A00BEA83A92503C1FC5version:V1.0project:lqfxmessageFormat:json3.3 参数生成示例（伪码）：paramMap.put(appKey, appKey);paramMap.put(version, V1.0);paramMap.put(project, project);paramMap.put(messageFormat, json);//加入请求方法相关参数：目前不做处理，为后面扩展准备paramMap.put(callerComId, callerComId);//请求方公司idparamMap.put(callerAppId, callerComId);//请求方应用id//业务参数paramMap.put(method, function);paramMap.put(arg 1, 业务参数1);paramMap.put(arg 2, 业务参数2);........paramMap.put(arg n, 业务参数n);//使用md5算法生成加密串String md5Str= MD5Util.getSign(paramMap, 系统appSecret);//将md5加密串加入参数集合paramMap.put(sign, md5Str);//参数转化String args = 将参数paramMap转换为json串；//调用String result = function(args);//处理结果..........3.2 功能及参数说明1. 录取概率预测调用方法:String forecastPorb(String arg)业务参数说明：业务参数说明code_city地市代码code_zone县区代码score用户输入的分数rank用户输入的排名返回值errCode说明:返回值说明-1错误密钥-2参数错误-3数据目前不可用-4系统故障-5网络异常1代表发送成功2. 往年各校录取分数统计调用方法:StringenrollStatistic(String arg)业务参数说明：业务参数说明code_city地市代码c