福建省教育资源公共服务平台_第1页
福建省教育资源公共服务平台_第2页
福建省教育资源公共服务平台_第3页
福建省教育资源公共服务平台_第4页
福建省教育资源公共服务平台_第5页
已阅读5页,还剩101页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

1、福建省教育资源公共服务平台3.0开放API接口规范福建省教育资源公共服务平台开放API接口规(V3.0)API访问鉴权介绍API调用时,应用向福建省教育资源公共服务平台请求token,福建省教育资源公共服务平台分配Token信息并指明有效期,只要在Token有效期内,应用无需重新发起Token申请,被调用方在第一次接收Token时发起验证请求,并保存token信息和有效期,只要在Token有效期内,后续调用就无需再向福建省教育资源公共服务平台申请Token验证。应用场景1.用户使用应用。2.应用执行处理逻辑。3.应用使用APPID,时间戳等参数向平台请求访问TOKEN。4.平台向应用返回访问T

2、OKEN。5.应用携带访问TOKEN请求调用平台API。6.平台对TOKEN进行校验并处理API调用请求,向应用返回调用结果。应用支付介绍用户购买应用中商品,应用向福建省教育资源公共服务平台发起扣费,福建省教育资源公共服务平台扣取用户云币,并根据商务合同分成规则向应用所属合作伙伴帐户存入相应云币。应用场景用户在应用购买学习资料。应用携带参数扣费相关参数重定向福建省教育资源公共服务平台进行扣费。福建省教育资源公共服务平台页面提示用户扣费,展示所购物品和费用相关信息。用户在扣费页面确认扣费。福建省教育资源公共服务平台扣取用户云币,将扣费结果返回到应用。福建省教育资源公共服务平台后台通知应用扣费结果

3、。应用向福建省教育资源公共服务平台返回扣费结果处理结果。单点登录介绍福建省教育资源公共服务平台集成多个业务系统,平台的前端展示门户对用户实现统一登录入口,只要在福建省教育资源公共服务平台登录的用户在福建省教育资源公共服务平台与各业务系统间不需要多次登录,进而实现对所有被授权的网络资源进行无缝访问了。单点登录场景用户登录福建省教育资源公共服务平台门户。福建省教育资源公共服务平台保存用户会话信息,在浏览器COOKIE中保存用户TGC信息。用户在福建省教育资源公共服务平台选择应用,福建省教育资源公共服务平台将用户重向至应用。用户在应用内访问受保护资源,应用将用户重定至福建省教育资源公共服务平台。福建

4、省教育资源公共服务平台从浏览器中获取用户TGC信息,并根据TGC校验用户会话。福建省教育资源公共服务平台生成ST,并携带ST将用户从福建省教育资源公共服务平台重定向至应用。应用使用ST请求平台校验。平台向应用返回校验结果及用户信息。单点登录配置说明:以下给出的配置是通用的客户端配置Demo,只适合跳转地址固定的场景(即serverName对应的value是固定的)。如有其他特殊需求,需客户端程序自己实现。Java语言客户端配置1.先把ssoclient.jar引入到项目的工程中(一般是lib)目录。2.在项目web.xml文件添加以下内容SSOFiltercom.whty.aam.client

5、.authentication.AuthenticationFiltercasServerLoginUrl/index.php?r=portal/user/loginserverName9:8088SSOFilter/*vlidationFiltercom.whty.aam.client.validation.Cas20ProxyReceivingTicketValidationFiltercasServerUrlPrefixhttp:/ :20014/aamif/ticketValidateserverName9:8088vlidationFilter/*com.whty.aam.clien

6、t.session.SingleSignOutHttpSessionListener SingleSignOutFiltercom.whty.aam.client.session.SingleSignOutFilterSingleSignOutFilter/*httpServletRequestWrapperFiltercom.whty.aam.client.util.HttpServletRequestWrapperFilterhttpServletRequestWrapperFilter/*AssertionThreadLocalFiltercom.whty.aam.client.util

7、.AssertionThreadLocalFilterAssertionThreadLocalFilter/*3.项目中取得ticket可用request.getSession().setAttribute(ticket, ticket);用ticket这名称从ssession中取得ticket。4.取得用户的usessionid可用com.whty.aam.client.authentication.AttributePrincipal这个类AttributePrincipal principal = (AttributePrincipal)request.getUserPrincipal(

8、);String usessionid = principal.getName();.net语言流程说明客户端配置需要拦截单点登录请求(如:http:/ip:port/sso/*),但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登录URL地址:HYPERLINK :10000/index.php?r=portal/user/login&service=:8080/ssotest;/index.php?r=portal/user/login&service=http:/ip:port/ssotest;URL拼写说明:service参数是用户登录后门户重定到客户端的地址,此参数必传不能缺

9、失;此处使用HYPERLINK :8080/ssotesthttp:/ip:port/ssotest为例子,需根据实际地址修改替换。用户在门户成功登录认证后,门户会根据service参数地址重定向到客户端(service参数传递的URL地址),并在URL地址后增加ticket参数。如:http:/ip:port/ssotest? ticket=*客户端获取到ticket值,重定向到用户中心验证ticket有效和合法性, url请求格式为::20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=。URL拼写说明: URL中IP与端

10、口可替换实际的ip与端口,ticket参数是用户中心要求必传不能缺失.客户端请求平台验证ticket,通过验证ticket的有效性,服务端校验通过后,会销毁该一次性ticket,并返回已登录用户名。返回验证后的的报文。验证通过的报文testss10验证不通过的报文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客户端解释XML报文对验证通过的报文取节点的值获取到当前登录的用户usessionid。客户端收到校验通过后的报文,取得用户usessionid,根据usessionid建立本地的用户会话。会话时间可默认为一小时,或根据需要具体配置.客户端再

11、根据usessionid调用平台接口取得当前用户的用户信息。其它语言配置流程说明客户端配置需要拦截单点登录请求(如:http:/ip:port/sso/*),但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登录URL地址:HYPERLINK :10000/index.php?r=portal/user/login&service=:8080/ssotest;/index.php?r=portal/user/login&service=http:/ip:port/ssotest;URL拼写说明:service参数是用户登录后门户重定到客户端的地址,此参数必传不能缺失;此处使用HYPERL

12、INK :8080/ssotesthttp:/ip:port/ssotest为例子,需根据实际地址修改替换。用户在门户成功登录认证后,门户会根据service参数地址重定向到客户端(service参数传递的URL地址),并在URL地址后增加ticket参数。如:http:/ip:port/ssotest? ticket=*客户端获取到ticket值,重定向到用户中心验证ticket有效和合法性, url请求格式为::20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=。URL拼写说明: URL中IP与端口可替换实际的ip与端口

13、,ticket参数是用户中心要求必传不能缺失.客户端请求平台验证ticket,通过验证ticket的有效性,服务端校验通过后,会销毁该一次性ticket,并返回已登录用户名。返回验证后的的报文。验证通过的报文testss10验证不通过的报文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客户端解释XML报文对验证通过的报文取节点的值获取到当前登录的用户usessionid。客户端收到校验通过后的报文,取得用户usessionid,根据usessionid建立本地的用户会话。会话时间可默认为一小时,或根据需要具体配置.客户端再根据usessionid

14、调用平台接口取得当前用户的用户信息。接口列表API访问鉴权接口接口名称接口方向接口描述获取访问TOKEN应用-福建省教育资源公共服务平台应用使用访问凭证获取访问令牌用户接口接口名称接口方向接口描述获取当前登录用户信息应用福建省教育资源公共服务平台应用根据单点登录会话ID查询用户信息获取用户基本信息应用福建省教育资源公共服务平台应用获取用户基本信息批量获取用户信息应用福建省教育资源公共服务平台应用批量获取添加此应用的用户信息获取用户好友应用福建省教育资源公共服务平台应用获取用户好友列表验证是否为好友应用福建省教育资源公共服务平台应用验证两个用户是否为好友查询班级信息应用福建省教育资源公共服务平台

15、应用根据班级ID获取班级信息查询班级成员信息应用福建省教育资源公共服务平台应用根据班级ID获取班级成员信息支付接口接口名称接口方向接口描述支付请求应用-福建省教育资源公共服务平台应用调用支付页面,请求使用云币支付页面跳转同步通知福建省教育资源公共服务平台应用用户在福建省教育资源公共服务平台支付完成后,返回至应用支付成功页面后台异步通知福建省教育资源公共服务平台应用用户在教云平台支付完成后,福建省教育资源公共服务平台后台通知应用支付结果消息接口接口名称接口方向接口描述发送消息应用-福建省教育资源公共服务平台应用调用接口向用户发送消息或应用以用户的身份向用户好友发送消息接口参考单点登录单点登录接口

16、登录成功后,单点登录平台生成票据信息ticket,SSO携带票据信息ticket并重定向到Service参数地址接口说明url/index.php?r=portal/user/login协议http是否需要鉴权无请求数限制无接口方向应用平台请求说明参数名称是否必须类型描述service必选string登录成功后重定向的应用的目标地址即应用的入口地址,例如:http:/ip:port/ssotest/返回说明登录成功后,重定向到目标地址 Ticket验证接口验证Ticket,验证成功后并返回当前登录用户标识。接口说明url:20014/aamif/ticketValidate协议http是否需要

17、鉴权无请求数限制无接口方向应用平台请求说明参数名称是否必须类型描述ticket必选string单点登录成功后生成的票据信息例如::20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=返回说明验证通过报文testss10验证不通过的报文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客户端解释XML报文对验证通过的报文取节点的值获取到当前登录的用户usessionid。客户端收到校验通过后的报文,取得用户usessionid,根据usessionid建立本地的用户会话。会话时间可默认

18、为一小时,或根据需要具体配置.客户端再根据usessionid调用平台接口取得当前用户的用户信息。API访问鉴权接口获取访问TOKEN接口说明应用调用平台开放API之前,请求获取访问TOKEN。请求说明url:20001/apigateway/getaccesstoken格式json协议post是否需要鉴权true请求数限制true接口方向应用平台参数说明参数名称是否必须类型描述appid必选String应用IDtimestamp必选String时间戳。keyinfo必选String对APPID、APPKEY、Timestamp进行sha1-hamc运算,加密串为APPID和APPKEY及Ti

19、mestamp字符串相连,以APPKEY为加密参数Php使用的签名函数:hash_hmac,hash_algos参数值为“sha1”返回值大写usessionid可选StringTicket验证返回的usessionid 返回说明返回码含义说明000000操作成功999999系统错误4.字段说明参数名称是否必须类型描述token必选Stringtoken信息validtime必选String有效期,只在有效期内(2小时),应用无需重新申请,服务保存token及有效期,有效期内只需做一次验证。platformCode必选String平台编码。六位数字,标明当前登录用户所属的平台 例如::2000

20、1/apigateway/getaccesstokenappid:AP000000012697,timestamp:1402968470233,keyinfo:170C718FB73BBB58D3CCEB52EB32D0CF93CA2E4B用户接口获取当前登录用户信息接口描述取得当前登录用户的用户信息请求说明url HYPERLINK :22015/aam/rest/user/getuserinfo/usessionid :20001/aam/rest/user/getuserinfo/usessionid?token=xxxxxxx格式-协议get是否需要鉴权true请求数限制true接口方

21、向应用平台参数说明无返回说明序号字段名约束类型长度说明1result必选string6结果000000:成功301999:usessionid验证失败2desc可选string250结果描述3usessionid必选String64唯一标识一个登录用户sessionid4ueserinfo可选4.1personid必选string60用户的统一ID;4.2mobnum可选string16手机号码4.3email可选string16邮箱4.4name可选string32用户姓名4.5nickname可选string100昵称4.6areacode可选string64用户归属地区域4.8gende

22、r可选string1性别0是女,1为男4.9birthday可选date16生日4.10usertype必选string1用户类型:学生:0老师:1家长:2机构:3学校:4学校工作人员:5机构工作人员:64.11address可选string256通讯地址4.12postcode可选string8邮编4.13userlogolist可选-头像LOGO(URL地址)列表4.1 logotype可选int1浏览渠道:1:小;2:中;3:大;4.2 logourl可选string512头像LOGO(URL地址)4.14interests可选string512兴趣,多个兴趣之间用分号分开4.15pro

23、fession可选string64职业4.16credtype可选string10:身份证1:护照2:军人证3:其他4.17idcardno可选string32证件号码4.18singature可选string140签名4.19fnascount可选int 粉丝数4.20teachesubjectlist可选 Json数组50如登录用户为教师,则返回所教学科,JSON数组4.20.1subjectid可选String32学科id4.20.2subjectname可选String50学科名称4.20.3teachmaterialid可选string32教材id4.20.4teachmateria

24、lname可选String200教材名称4.20.5classid可选string32用户所在班级id4.20.6classname可选string50班级名称4.20.7foundtime可选string4班级成立年份4.20.8grade可选String31:一年级 2:二年级 3:三年级 4:四年级 5:五年级 6:六年级 7:初一 8:初二 9:初三 10:高一 11:高二 12:高三13: 职一14:职二15:职三4.20.9studysection可选string31:小学2:初中3:高中4:高职4.21classid可选string50用户所在班级名称;当登录用户为学生是会返回该

25、值4.22classname可选string50班级名称;当登录用户为学生是会返回该值4.23classidentity可选JOSN数组2用户所在班级身份: 1:班主任 2:班长 3:管理员4: 教师 5:成员 6:教研员,7:教务员,8:信息员4.24orgaid可选string32用户所在机构学校id4.25organame可选string200用户所在机构学校名称4.26orgaidentity可选JOSN数组2用户在机构身份:0平台管理员1超级管理员2央馆资源提供者3评审专家4资源综合部管理员5基础教育资源部管理员6职业教育资源部管理员7专题教育资源部管理员8运营管理员9运维管理员10

26、央馆内容资源提供商11央馆应用资源提供商12机构管理员13产品管理员14资源管理员15内容提供商16应用提供商17机构资源提供者18普通成员4.27tags可选string1000个人标签4.28updateTime可选string更新时间(2014-06-23 15:38:06)5platformCode必选String平台编码,中央平台000000请求消息示例:请求URL: :20001/aam/rest/user/getuserinfo/da9933b0-65a7-41ac-9858-1e01d23c7977?token=xxxxxxxxx消息响应示例: result : 000000,

27、 usessionid : da9933b0-65a7-41ac-9858-1e01d23c7977,platformCode : 000000, userinfo : personid : CF4D06BE8BC74A59866FFBE2745EB519, birthday : 1990-10-23, gender : 1, name : 柯宏树, usertype : 0, idcardno : fnascount : 0, userlogolist : , orgaid : C13B6DE0493848558F03F0B36B3F229B, org

28、aname : 华中师范大学第一附属中学, orgaidentity : 5 , classid : 335181135C6A41F595C84008F3957C58, classname : 高二(12)班, classidentity : 5 , account :根据账号获取用户基本信息接口说明应用根据账号可以获取经过登录认证后用户的基本信息。请求说明url HYPERLINK :22015/aam/rest/getUserInfoReq :20001/aam/rest/getUserInfoReq?token=xxxxxxxx格式json协议post是否需要鉴

29、权true请求数限制true接口方向应用-平台account:用户账号参数说明序号字段名约束类型长度说明1account必选string-用户账号2platformcode可选string区域平台编码Json请求串 : account:Testss10,platformcode: 000000返回说明序号字段名约束类型长度说明1result必选string6结果000000:成功301001:用户不存在301999:usessionid验证失败2ueserinfo可选2.1personid必选string60用户的统一ID;2.2mobnum可选string16手机号码2.3email可选st

30、ring16邮箱2.4name可选string32用户姓名2.5nickname可选string100昵称2.6areacode可选string64用户归属地区域2.7gender可选string1性别0是女,1为男2.8birthday可选date16生日2.9usertype必选string1用户类型学生:0老师:1家长:2机构:32.10address可选string256通讯地址2.11postcode可选string8邮编2.12userlogolist可选-头像LOGO(URL地址)列表2.12.1logotype可选int1浏览渠道:1:小;2:中;3:大;2.11.2logou

31、rl可选string512头像LOGO(URL地址)2.13interests可选string512兴趣,多个兴趣之间用分号分开2.14profession可选string64职业2.15singature可选string140签名2.16tags可选string1000个人标签2.19account可选Stirng100账号2.20orgaid可选String32用户所在机构学校id2.21orgname可选String200用户所在机构学校名称2.22classlist可选String2.22.1classid必选String32用户所在班级ID2.22.2classname必选Strin

32、g200用户所在班级名称2.23teachesubjectlist可选 Json数组50如登录用户为教师,则返回所教学科,JSON数组2.23.1subjectid可选String32学科id2.23.2subjectname可选String50学科名称2.23.3teachmaterialid可选string32教材id2.23.4teachmaterialname可选String200教材名称2.23.5classid可选string32用户所在班级id2.23.6grade可选String31:一年级 2:二年级 3:三年级 4:四年级 5:五年级 6:六年级 7:初一 8:初二 9:初

33、三 10:高一 11:高二 12:高三13: 职一14:职二15:职三2.23.7studysection可选String31:小学2:初中3:高中4:高职2.23.6classname可选string50班级名称2.23.7foundtime可选string4班级成立年份2.23.8updateTime可选string更新时间(2014-06-23 15:38:06)消息响应示例 “result”: “000000”, “ueserinfo”: “personid”: “cbdf195ddd1c40efbd3c48ca97c0cbe2”, “mobnum”: , “

34、birthday”: “, “gender”: “1”, “name”: “Testss10”, “usertype”: “5”, “credtype”: “0 “, “idcardno”: , “fnascount”: 0, “userlogolist”: , “account”: “Testss10” 批量获取用户信息接口说明应用获取安装此应用的用户信息。请求说明url:20001/aam/rest/getBatchUserInfoReq?token=xxxxxxxx格式json协议post是否需要鉴权true请求数限制true接口方向应用平台参数说

35、明序号字段名约束类型长度说明1personids必选JOSN数组多个用户ID2platformcode可选string平台编码返回说明序号字段名约束类型长度说明1result必选string6结果000000:成功301001:用户不存在301999:usessionid验证失败2ueserinfo可选2.1personid必选string60用户的统一ID;2.2mobnum可选string16手机号码2.3email可选string16邮箱2.4name可选string32用户姓名2.5nickname可选string100昵称2.6areacode可选string64用户归属地区域2.8

36、gender可选string1性别0是女,1为男2.9birthday可选date16生日2.10usertype必选string1用户类型学生:0老师:1家长:2机构:32.11address可选string256通讯地址2.12postcode可选string8邮编2.13userlogolist可选-头像LOGO(URL地址)列表2.13.1logotype可选int1浏览渠道:1:小;2:中;3:大;2.13.2logourl可选string512头像LOGO(URL地址)2.14interests可选string512兴趣,多个兴趣之间用分号分开2.15profession可选str

37、ing64职业2.18singature可选string140签名2.19tags可选string1000个人标签2.20account可选Stirng100账号2.21orgaid可选String32用户所在机构学校id2.22orgname可选String200用户所在机构学校名称2.23classlist可选String2.23.1classid必选String32用户所在班级ID2.23.2classname必选String200用户所在班级名称返回结果例子“result”: “000000”,“ueserinfo”: “personid”: “cbdf195ddd1c40efbd3c

38、48ca97c0cbe2”,“mobnum”: ,“birthday”: “,“gender”: “1”,“name”: “Testss10”,“usertype”: “5”,“credtype”: “0 “,“idcardno”: ,“fnascount”: 0,“userlogolist”: ,“account”: “Testss10” 获取用户好友接口说明应用可以调用查询用户好友接口,在用户授权的情况下,可以在福建省教育资源公共服务平台上查询用户的好友信息。请求说明url:20001/aam/rest/queryFrien

39、dsReq?token=xxxxxxxx格式-协议Post是否需要鉴权true请求数限制true接口方向应用平台参数说明序号字段名约束类型长度说明1personid必选string64用户ID2start可选String64查询开始位置,不填默认为03end可选String64查询结束位置,不填默认为104platformcode可选String64平台区域码 “personid”: “49659461d4094c7f830204175588e2ea”,“start”: “0”,“end”:“10”,“platformcode”:“100001”返回说明序号字段名约束类型长度说明1result

40、必选string6结果000000:成功301001:用户不存在2start必选int查询开始位置3end必选int查询结束位置4count必选int总记录条数5list可选成员信息列表5.1peronsid可选String32用户id5.2account可选String20用户名5.3name可选string32用户姓名5.4connecthetime可选date32关注时间,我主动关注他的时间5.5connectmetime可选string100关注时间,他关注我的时间5.6userlogolist可选-头像LOGO(URL地址)列表5.6.1logotype可选int1头像类型:1:小;

41、2:中;3:大;5.6.2logourl可选string512头像LOGO(URL地址)返回结果例子“retcode”:“000000”, “count”:“2”,“start”:“0”,“end”:“10”,“list”: “personid”:“1289301erwopUJYHDW24”,“areacode”:“510000”“mobNum“: ,“email”: “123456”,“name”: “test”, “personid”:“1289301erwopUJYHDW23”,“areacode”:“510000”“mobNum“:

42、,“email”: “1234567”,“name”: “test2” ,验证用户是否为好友接口说明应用可以调用验证用户是否为好友接口,验证是否为好友请求说明url :22015/aam/rest/validaFriendsReq?token=xxxxxxxx格式json协议post是否需要鉴权true请求数限制true接口方向应用平台参数说明序号参数名称是否必须类型描述1personid必须String用户id2friendid必选String好友的用户id3platformcode可选String平台区域码返回说明返回码含义说明000000验证成功,为好友关系301001用户不存在3011

43、22好友不存在字段说明字段名约束类型说明result必选string返回码desc可选String返回消息说明返回结果例子“result”:“000000”, “desc”:“验证成功” 查询班级信息接口描述根据班级ID查询班级信息请求说明url:20001/aam/rest/queryClassInfoReq?token=xxxxxxxx支持验证方式格式json协议post是否需要鉴权true请求数限制true接口方向展现平台参数说明序号字段名约束类型长度说明1classids必选Json数组-班级id的JSON数组,一个或多个2platformcode可选String6平台编码classi

44、ds:00d81f28cdbf412c8757a3b92ffeed48,19e0f91aaf224fb28a712537418a379c,5e5ed67bc84b4b10ba5bce8d4bd12385,platformcode:000000返回说明序号字段名约束类型长度说明1result必选string6结果000000:查询成功2desc可选 string50返回描述3classinfolist可选班级信息JSON数组3.1classid可选string32班级ID3.2orgaid可选string32所属机构/学校编号3.3classname可选string50班级名称3.4gradec

45、lass可选int2班别相应的数字,代表相应班别,如:1代表1班3.5grade可选int2年级1:一年级2:二年级3:三年级4:四年级5:五年级6:六年级7:初一8:初二9:初三10:高一11:高二12:高三3.6foundtime可选string32成立年份3.7created可选string32创建时3.8membercount可选int6成员数3.9classmanager可选string32班级管理员信息3.9.1personid可选string32管理员用户ID3.9.2name可选string50管理员姓名3.10headteacher可选string32班主任信息3.10.1p

46、ersonid可选string32班主任用户ID3.10.2name可选string50班主任姓名3.11classmonitor可选string50班长信息3.11.1personid可选string32班长用户ID3.11.2name可选string50班长姓名3.12teacherlist可选String50班级教师信息3.12.1personid可选string32教师用户ID3.12.2name可选string50教师姓名3.13classalises可选string50班级别名3.14flagpic可选string256班级标识图片(URL)3.15classcate可选strin

47、g1班级类型0:普通班1:实验班查询班级成员信息接口描述查询成员信息。请求说明urlHYPERLINK 1:16001/aam/rest/queryClassMemberReq?:20001/aam/rest/queryClassMemberReq?token=xxxxxxxx支持验证方式格式json协议post是否需要鉴权true请求数限制true接口方向展现平台参数说明序号字段名约束类型长度说明1classid必选string-班级id 2start必选int记录开始数3end必选int记录结束数4platformcode可选string平台编码 中央平台:000000示例:classid

48、:00d81f28cdbf412c8757a3b92ffeed48,“start”:”0”,end:10,platformcode:000000,返回说明序号字段名约束类型长度说明1result必选string6结果000000:成功2start必选int查询开始位置3end必选int查询结束位置4count必选int总记录条数5userinfo可选5.1personid必选string60用户的统一ID;5.2mobnum可选string16手机号码5.3email可选string16邮箱5.4name可选string32用户姓名5.5usertype必选string1用户类型学生:0老师:

49、15.6teachesubjectlist可选 Json数组50如用户为教师,则返回所教学科,JSON数组5.6.1subjectid可选String32学科id5.6.2subjectname可选String50学科名称5.6.3teachmaterialid可选string32教材id5.6.4teachmaterialname可选String200教材名称用户登录(C/S模式应用)接口描述C/S系统调用该接口实现用户帐号登录,密码可以是静态密码也可以是动态密码。请求说明url HYPERLINK /aam/rest/account/login :20001/aam/rest/accoun

50、t/login?token=xxxxxxxx支持验证方式格式json协议post是否需要鉴权true请求数限制true接口方向应用AAM参数说明序号字段名约束类型长度说明1account必选string128注册账号。2password必选string32静态密码或动态密码;静态密码加密方式:MD5加密后字母字符为大写的字符串,再经过RC4加密(加密的密钥user_sercretkey);密码经过加密后再传输;动态密码登录时,为明文。当采用静态密码或动态密码方式认证时,必选。3passwdtype可选string4密码类型:默认是00:静态密码1:动态密码4portaltype必选string

51、1登陆来源99:其他例如:HYPERLINK /aam/rest/account/login:20001/aam/rest/account/login?token=xxxxxxxx account:aa12321,password:aKvpxU1LekEffCbAE5rntY11I3Mlgj2n0QK8OiyRrRDeL6hB8G8ivc5AM+TABiGvH9nRqN/GWJ26JbA,portaltype:0返回说明序号字段名约束类型长度说明1result必选string6订购结果000000:成功301001:用户不存在2desc可选string250结果描述3tgcticke可选Str

52、ing64永久Ticket,唯一标识一个登录用户4usessionid可选String64唯一标识一个登录用户sessionid5ueserinfo可选5.1personid必选string60用户的统一ID;5.2mobnum可选string16手机号码5.3email可选string16邮箱5.4name可选string32用户姓名5.5nickname可选string100昵称5.6areacode可选string64用户归属地区域5.7name可选string16姓名5.8gender可选string1性别0是女,1为男5.9birthday可选date16生日5.10usertype

53、必选string1用户类型:学生:0老师:1家长:2机构:3学校:4学校工作人员:5机构工作人员:65.11address可选string256通讯地址5.12postcode可选string8邮编5.13userlogolist可选-头像LOGO(URL地址)列表5.13.1logotype可选int1浏览渠道:1:小;2:中;3:大;5.13.2logourl可选string512头像LOGO(URL地址)5.14interests可选string512兴趣,多个兴趣之间用分号分开5.15profession可选string64职业5.16credtype可选string10:身份证1:护

54、照2:军人证3:其他5.17idcardno可选string32证件号码5.18singature可选string140签名5.19fnascount可选int 粉丝数5.20teachesubjectlist可选 Json数组50如登录用户为教师,则返回所教学科,JSON数组5.20.1subjectid可选String32学科id5.20.2subjectname可选String50学科名称5.20.3teachmaterialid可选string32教材id5.20.4teachmaterialname可选String200教材名称5.20.5classid可选string32用户所在班

55、级id5.20.6classname可选string50班级名称5.20.7foundtime可选string4班级成立年份5.21classid可选string50用户所在班级名称5.22classname可选string50班级名称5.23classidentity可选JOSN数组2用户所在班级身份: 1:班主任 2:班长 3:管理员4: 教师 5:成员 6:教研员,7:教务员,8:信息员5.24orgaid可选string32用户所在机构学校id5.25organame可选string200用户所在机构学校名称5.26orgaidentity可选string2用户在机构身份:1:管理员2

56、:成员3:教研员;4:教务员;5:信息员,5.27tags可选string1000个人标签5.28areacode可选string8所在地区编码查询班级列表接口描述根据机构ID或班级ID查询班级列表请求说明url:20001/aam/rest/queryClassInfoListReq?token=xxxxxxxx支持验证方式格式json协议post是否需要鉴权true请求数限制true接口方向应用平台参数说明序号字段名约束类型长度说明1orgaid可选string64可为机构ID、学校ID2start可选string20查询开始记录下标3end可选string30查询结束记录下标4class

57、ids可选String20班级id的JSON数组,一个或多个5platformcode可选String平台编码返回说明序号字段名约束类型长度说明1result必选string6结果000000:成功2start必选String8查询开始位置3end必选String8查询结束位置4count必选String8总记录条数5classinfolist可选班级信息列表5.1classid可选string32班级ID5.2orgaid可选string32所属机构/学校编号5.3classname可选string20班级名称5.4gradeclass可选int班别相应的数字,代表相应班别,如:1代表1班5

58、.5grade可选int年级1:一年级2:二年级3:三年级4:四年级5:五年级6:六年级7:初一8:初二9:初三10:高一11:高二12:高三5.6foundtime可选string32成立年份5.7jointype可选string1加入方式;1:申请加入;2:邀请加入; 3:输入验证码加入5.8joinvalinum可选string20加入验证码5.9invitepermi可选string1邀请权限;1:成员可邀请其他人加入2:只有班主任或班长邀请加入5.10created可选string32创建时间5.11membercount可选int成员数5.12classmanager可选strin

59、g32管理员,用户ID5.12.1personid可选string32用户ID5.12.2name可选string10姓名5.13headteacher可选string32班主任,用户ID5.13.1personid可选string32用户ID5.13.2name可选string10姓名5.14classmonitor可选string32班长,用户id5.14.1personid可选string32用户ID5.14.2name可选string10姓名5.15teacherlist可选String32班级教师,用户ID数组5.15.1personid可选string32用户ID5.15.2nam

60、e可选string10姓名5.16classalises可选string50班级别名5.17flagpic可选string256班级标识图片(URL)5.18classcate可选string1班级类型0:普通班1:实验班查询班级学生接口描述查询学校班级学生请求说明urlHYPERLINK 1:16001/aam/rest/queryClassStudentReq:20001/aam/rest/queryClassStudentReq?token=xxxxxxxx支持验证方式-格式json协议post是否需要鉴权true请求数限制true接口方向应用平台参数说明序号字段名约束类型长度说明1sc

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论