福建省教育資源公共服務(wù)平臺

1、福建省教育資源公共服務(wù)平臺3.0開放API接口規(guī)范福建省教育資源公共服務(wù)平臺開放API接口規(guī)（V3.0）API訪問鑒權(quán)介紹API調(diào)用時，應(yīng)用向福建省教育資源公共服務(wù)平臺請求token，福建省教育資源公共服務(wù)平臺分配Token信息并指明有效期，只要在Token有效期內(nèi)，應(yīng)用無需重新發(fā)起Token申請，被調(diào)用方在第一次接收Token時發(fā)起驗證請求，并保存token信息和有效期，只要在Token有效期內(nèi)，后續(xù)調(diào)用就無需再向福建省教育資源公共服務(wù)平臺申請Token驗證。應(yīng)用場景1.用戶使用應(yīng)用。2.應(yīng)用執(zhí)行處理邏輯。3.應(yīng)用使用APPID，時間戳等參數(shù)向平臺請求訪問TOKEN。4.平臺向應(yīng)用返回訪問T

2、OKEN。5.應(yīng)用攜帶訪問TOKEN請求調(diào)用平臺API。6.平臺對TOKEN進行校驗并處理API調(diào)用請求，向應(yīng)用返回調(diào)用結(jié)果。應(yīng)用支付介紹用戶購買應(yīng)用中商品，應(yīng)用向福建省教育資源公共服務(wù)平臺發(fā)起扣費，福建省教育資源公共服務(wù)平臺扣取用戶云幣，并根據(jù)商務(wù)合同分成規(guī)則向應(yīng)用所屬合作伙伴帳戶存入相應(yīng)云幣。應(yīng)用場景用戶在應(yīng)用購買學(xué)習資料。應(yīng)用攜帶參數(shù)扣費相關(guān)參數(shù)重定向福建省教育資源公共服務(wù)平臺進行扣費。福建省教育資源公共服務(wù)平臺頁面提示用戶扣費，展示所購物品和費用相關(guān)信息。用戶在扣費頁面確認扣費。福建省教育資源公共服務(wù)平臺扣取用戶云幣，將扣費結(jié)果返回到應(yīng)用。福建省教育資源公共服務(wù)平臺后臺通知應(yīng)用扣費結(jié)果

3、。應(yīng)用向福建省教育資源公共服務(wù)平臺返回扣費結(jié)果處理結(jié)果。單點登錄介紹福建省教育資源公共服務(wù)平臺集成多個業(yè)務(wù)系統(tǒng)，平臺的前端展示門戶對用戶實現(xiàn)統(tǒng)一登錄入口，只要在福建省教育資源公共服務(wù)平臺登錄的用戶在福建省教育資源公共服務(wù)平臺與各業(yè)務(wù)系統(tǒng)間不需要多次登錄，進而實現(xiàn)對所有被授權(quán)的網(wǎng)絡(luò)資源進行無縫訪問了。單點登錄場景用戶登錄福建省教育資源公共服務(wù)平臺門戶。福建省教育資源公共服務(wù)平臺保存用戶會話信息，在瀏覽器COOKIE中保存用戶TGC信息。用戶在福建省教育資源公共服務(wù)平臺選擇應(yīng)用，福建省教育資源公共服務(wù)平臺將用戶重向至應(yīng)用。用戶在應(yīng)用內(nèi)訪問受保護資源，應(yīng)用將用戶重定至福建省教育資源公共服務(wù)平臺。福建

4、省教育資源公共服務(wù)平臺從瀏覽器中獲取用戶TGC信息，并根據(jù)TGC校驗用戶會話。福建省教育資源公共服務(wù)平臺生成ST，并攜帶ST將用戶從福建省教育資源公共服務(wù)平臺重定向至應(yīng)用。應(yīng)用使用ST請求平臺校驗。平臺向應(yīng)用返回校驗結(jié)果及用戶信息。單點登錄配置說明：以下給出的配置是通用的客戶端配置Demo，只適合跳轉(zhuǎn)地址固定的場景（即serverName對應(yīng)的value是固定的）。如有其他特殊需求，需客戶端程序自己實現(xiàn)。Java語言客戶端配置1.先把ssoclient.jar引入到項目的工程中（一般是lib）目錄。2.在項目web.xml文件添加以下內(nèi)容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/*），但客戶端服務(wù)器攔截到單點登錄請求時重定向到登錄頁面。用戶登錄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參數(shù)是用戶登錄后門戶重定到客戶端的地址，此參數(shù)必傳不能缺

9、失;此處使用HYPERLINK :8080/ssotesthttp:/ip:port/ssotest為例子，需根據(jù)實際地址修改替換。用戶在門戶成功登錄認證后，門戶會根據(jù)service參數(shù)地址重定向到客戶端（service參數(shù)傳遞的URL地址），并在URL地址后增加ticket參數(shù)。如：http:/ip:port/ssotest? ticket=*客戶端獲取到ticket值，重定向到用戶中心驗證ticket有效和合法性， url請求格式為：:20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=。URL拼寫說明： URL中IP與端

10、口可替換實際的ip與端口，ticket參數(shù)是用戶中心要求必傳不能缺失.客戶端請求平臺驗證ticket，通過驗證ticket的有效性，服務(wù)端校驗通過后，會銷毀該一次性ticket,并返回已登錄用戶名。返回驗證后的的報文。驗證通過的報文testss10驗證不通過的報文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客戶端解釋XML報文對驗證通過的報文取節(jié)點的值獲取到當前登錄的用戶usessionid?？蛻舳耸盏叫ｒ炌ㄟ^后的報文，取得用戶usessionid，根據(jù)usessionid建立本地的用戶會話。會話時間可默認為一小時，或根據(jù)需要具體配置.客戶端再

11、根據(jù)usessionid調(diào)用平臺接口取得當前用戶的用戶信息。其它語言配置流程說明客戶端配置需要攔截單點登錄請求（如：http:/ip:port/sso/*），但客戶端服務(wù)器攔截到單點登錄請求時重定向到登錄頁面。用戶登錄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參數(shù)是用戶登錄后門戶重定到客戶端的地址，此參數(shù)必傳不能缺失;此處使用HYPERL

12、INK :8080/ssotesthttp:/ip:port/ssotest為例子，需根據(jù)實際地址修改替換。用戶在門戶成功登錄認證后，門戶會根據(jù)service參數(shù)地址重定向到客戶端（service參數(shù)傳遞的URL地址），并在URL地址后增加ticket參數(shù)。如：http:/ip:port/ssotest? ticket=*客戶端獲取到ticket值，重定向到用戶中心驗證ticket有效和合法性， url請求格式為：:20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=。URL拼寫說明： URL中IP與端口可替換實際的ip與端口

13、，ticket參數(shù)是用戶中心要求必傳不能缺失.客戶端請求平臺驗證ticket，通過驗證ticket的有效性，服務(wù)端校驗通過后，會銷毀該一次性ticket,并返回已登錄用戶名。返回驗證后的的報文。驗證通過的報文testss10驗證不通過的報文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客戶端解釋XML報文對驗證通過的報文取節(jié)點的值獲取到當前登錄的用戶usessionid?？蛻舳耸盏叫ｒ炌ㄟ^后的報文，取得用戶usessionid，根據(jù)usessionid建立本地的用戶會話。會話時間可默認為一小時，或根據(jù)需要具體配置.客戶端再根據(jù)usessionid

14、調(diào)用平臺接口取得當前用戶的用戶信息。接口列表API訪問鑒權(quán)接口接口名稱接口方向接口描述獲取訪問TOKEN應(yīng)用-福建省教育資源公共服務(wù)平臺應(yīng)用使用訪問憑證獲取訪問令牌用戶接口接口名稱接口方向接口描述獲取當前登錄用戶信息應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用根據(jù)單點登錄會話ID查詢用戶信息獲取用戶基本信息應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用獲取用戶基本信息批量獲取用戶信息應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用批量獲取添加此應(yīng)用的用戶信息獲取用戶好友應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用獲取用戶好友列表驗證是否為好友應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用驗證兩個用戶是否為好友查詢班級信息應(yīng)用福建省教育資源公共服務(wù)平臺

15、應(yīng)用根據(jù)班級ID獲取班級信息查詢班級成員信息應(yīng)用福建省教育資源公共服務(wù)平臺應(yīng)用根據(jù)班級ID獲取班級成員信息支付接口接口名稱接口方向接口描述支付請求應(yīng)用-福建省教育資源公共服務(wù)平臺應(yīng)用調(diào)用支付頁面，請求使用云幣支付頁面跳轉(zhuǎn)同步通知福建省教育資源公共服務(wù)平臺應(yīng)用用戶在福建省教育資源公共服務(wù)平臺支付完成后，返回至應(yīng)用支付成功頁面后臺異步通知福建省教育資源公共服務(wù)平臺應(yīng)用用戶在教云平臺支付完成后，福建省教育資源公共服務(wù)平臺后臺通知應(yīng)用支付結(jié)果消息接口接口名稱接口方向接口描述發(fā)送消息應(yīng)用-福建省教育資源公共服務(wù)平臺應(yīng)用調(diào)用接口向用戶發(fā)送消息或應(yīng)用以用戶的身份向用戶好友發(fā)送消息接口參考單點登錄單點登錄接口

16、登錄成功后，單點登錄平臺生成票據(jù)信息ticket，SSO攜帶票據(jù)信息ticket并重定向到Service參數(shù)地址接口說明url/index.php?r=portal/user/login協(xié)議http是否需要鑒權(quán)無請求數(shù)限制無接口方向應(yīng)用平臺請求說明參數(shù)名稱是否必須類型描述service必選string登錄成功后重定向的應(yīng)用的目標地址即應(yīng)用的入口地址，例如：http:/ip:port/ssotest/返回說明登錄成功后，重定向到目標地址 Ticket驗證接口驗證Ticket，驗證成功后并返回當前登錄用戶標識。接口說明url:20014/aamif/ticketValidate協(xié)議http是否需要

17、鑒權(quán)無請求數(shù)限制無接口方向應(yīng)用平臺請求說明參數(shù)名稱是否必須類型描述ticket必選string單點登錄成功后生成的票據(jù)信息例如：:20014/aamif/ticketValidate?ticket= SO6YEWI93093UTYDVXBZ4513=返回說明驗證通過報文testss10驗證不通過的報文Ticket SO6YEWI93093UTYDVXBZ4513= not recognized客戶端解釋XML報文對驗證通過的報文取節(jié)點的值獲取到當前登錄的用戶usessionid?？蛻舳耸盏叫ｒ炌ㄟ^后的報文，取得用戶usessionid，根據(jù)usessionid建立本地的用戶會話。會話時間可默認

18、為一小時，或根據(jù)需要具體配置.客戶端再根據(jù)usessionid調(diào)用平臺接口取得當前用戶的用戶信息。API訪問鑒權(quán)接口獲取訪問TOKEN接口說明應(yīng)用調(diào)用平臺開放API之前，請求獲取訪問TOKEN。請求說明url:20001/apigateway/getaccesstoken格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說明參數(shù)名稱是否必須類型描述appid必選String應(yīng)用IDtimestamp必選String時間戳。keyinfo必選String對APPID、APPKEY、Timestamp進行sha1-hamc運算，加密串為APPID和APPKEY及Ti

19、mestamp字符串相連,以APPKEY為加密參數(shù)Php使用的簽名函數(shù)：hash_hmac，hash_algos參數(shù)值為“sha1”返回值大寫usessionid可選StringTicket驗證返回的usessionid 返回說明返回碼含義說明000000操作成功999999系統(tǒng)錯誤4.字段說明參數(shù)名稱是否必須類型描述token必選Stringtoken信息validtime必選String有效期，只在有效期內(nèi)(2小時)，應(yīng)用無需重新申請，服務(wù)保存token及有效期，有效期內(nèi)只需做一次驗證。platformCode必選String平臺編碼。六位數(shù)字，標明當前登錄用戶所屬的平臺 例如：: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格式-協(xié)議get是否需要鑒權(quán)true請求數(shù)限制true接口方

21、向應(yīng)用平臺參數(shù)說明無返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:成功301999:usessionid驗證失敗2desc可選string250結(jié)果描述3usessionid必選String64唯一標識一個登錄用戶sessionid4ueserinfo可選4.1personid必選string60用戶的統(tǒng)一ID；4.2mobnum可選string16手機號碼4.3email可選string16郵箱4.4name可選string32用戶姓名4.5nickname可選string100昵稱4.6areacode可選string64用戶歸屬地區(qū)域4.8gende

22、r可選string1性別0是女，1為男4.9birthday可選date16生日4.10usertype必選string1用戶類型:學(xué)生:0老師:1家長:2機構(gòu):3學(xué)校：4學(xué)校工作人員：5機構(gòu)工作人員：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職業(yè)4.16credtype可選string10:身份證1:護照2:軍人證3:其他4.17idcardno可選string32證件號碼4.18singature可選string140簽名4.19fnascount可選int 粉絲數(shù)4.20teachesubjectlist可選 Json數(shù)組50如登錄用戶為教師，則返回所教學(xué)科，JSON數(shù)組4.20.1subjectid可選String32學(xué)科id4.20.2subjectname可選String50學(xué)科名稱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:小學(xué)2:初中3:高中4:高職4.21classid可選string50用戶所在班級名稱；當?shù)卿浻脩魹閷W(xué)生是會返回該

25、值4.22classname可選string50班級名稱；當?shù)卿浻脩魹閷W(xué)生是會返回該值4.23classidentity可選JOSN數(shù)組2用戶所在班級身份: 1:班主任 2：班長 3：管理員4: 教師 5：成員 6：教研員，7：教務(wù)員，8：信息員4.24orgaid可選string32用戶所在機構(gòu)學(xué)校id4.25organame可選string200用戶所在機構(gòu)學(xué)校名稱4.26orgaidentity可選JOSN數(shù)組2用戶在機構(gòu)身份：0平臺管理員1超級管理員2央館資源提供者3評審專家4資源綜合部管理員5基礎(chǔ)教育資源部管理員6職業(yè)教育資源部管理員7專題教育資源部管理員8運營管理員9運維管理員10

26、央館內(nèi)容資源提供商11央館應(yīng)用資源提供商12機構(gòu)管理員13產(chǎn)品管理員14資源管理員15內(nèi)容提供商16應(yīng)用提供商17機構(gòu)資源提供者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消息響應(yīng)示例： 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 : 華中師范大學(xué)第一附屬中學(xué), orgaidentity : 5 , classid : 335181135C6A41F595C84008F3957C58, classname : 高二(12)班, classidentity : 5 , account :根據(jù)賬號獲取用戶基本信息接口說明應(yīng)用根據(jù)賬號可以獲取經(jīng)過登錄認證后用戶的基本信息。請求說明url HYPERLINK :22015/aam/rest/getUserInfoReq :20001/aam/rest/getUserInfoReq?token=xxxxxxxx格式j(luò)son協(xié)議post是否需要鑒

29、權(quán)true請求數(shù)限制true接口方向應(yīng)用-平臺account:用戶賬號參數(shù)說明序號字段名約束類型長度說明1account必選string-用戶賬號2platformcode可選string區(qū)域平臺編碼Json請求串 ： account:Testss10,platformcode: 000000返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:成功301001:用戶不存在301999:usessionid驗證失敗2ueserinfo可選2.1personid必選string60用戶的統(tǒng)一ID；2.2mobnum可選string16手機號碼2.3email可選st

30、ring16郵箱2.4name可選string32用戶姓名2.5nickname可選string100昵稱2.6areacode可選string64用戶歸屬地區(qū)域2.7gender可選string1性別0是女，1為男2.8birthday可選date16生日2.9usertype必選string1用戶類型學(xué)生:0老師:1家長:2機構(gòu):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職業(yè)2.15singature可選string140簽名2.16tags可選string1000個人標簽2.19account可選Stirng100賬號2.20orgaid可選String32用戶所在機構(gòu)學(xué)校id2.21orgname可選String200用戶所在機構(gòu)學(xué)校名稱2.22classlist可選String2.22.1classid必選String32用戶所在班級ID2.22.2classname必選Strin

32、g200用戶所在班級名稱2.23teachesubjectlist可選 Json數(shù)組50如登錄用戶為教師，則返回所教學(xué)科，JSON數(shù)組2.23.1subjectid可選String32學(xué)科id2.23.2subjectname可選String50學(xué)科名稱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:小學(xué)2:初中3:高中4:高職2.23.6classname可選string50班級名稱2.23.7foundtime可選string4班級成立年份2.23.8updateTime可選string更新時間（2014-06-23 15:38:06）消息響應(yīng)示例 “result”: “000000”, “ueserinfo”: “personid”: “cbdf195ddd1c40efbd3c48ca97c0cbe2”, “mobnum”: , “

34、birthday”: “, “gender”: “1”, “name”: “Testss10”, “usertype”: “5”, “credtype”: “0 “, “idcardno”: , “fnascount”: 0, “userlogolist”: , “account”: “Testss10” 批量獲取用戶信息接口說明應(yīng)用獲取安裝此應(yīng)用的用戶信息。請求說明url:20001/aam/rest/getBatchUserInfoReq?token=xxxxxxxx格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說

35、明序號字段名約束類型長度說明1personids必選JOSN數(shù)組多個用戶ID2platformcode可選string平臺編碼返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:成功301001:用戶不存在301999:usessionid驗證失敗2ueserinfo可選2.1personid必選string60用戶的統(tǒng)一ID；2.2mobnum可選string16手機號碼2.3email可選string16郵箱2.4name可選string32用戶姓名2.5nickname可選string100昵稱2.6areacode可選string64用戶歸屬地區(qū)域2.8

36、gender可選string1性別0是女，1為男2.9birthday可選date16生日2.10usertype必選string1用戶類型學(xué)生:0老師:1家長:2機構(gòu):32.11address可選string256通訊地址2.12postcode可選string8郵編2.13userlogolist可選-頭像LOGO（URL地址）列表2.13.1logotype可選int1瀏覽渠道：1：?。?：中；3：大；2.13.2logourl可選string512頭像LOGO（URL地址）2.14interests可選string512興趣，多個興趣之間用分號分開2.15profession可選str

37、ing64職業(yè)2.18singature可選string140簽名2.19tags可選string1000個人標簽2.20account可選Stirng100賬號2.21orgaid可選String32用戶所在機構(gòu)學(xué)校id2.22orgname可選String200用戶所在機構(gòu)學(xué)校名稱2.23classlist可選String2.23.1classid必選String32用戶所在班級ID2.23.2classname必選String200用戶所在班級名稱返回結(jié)果例子“result”: “000000”,“ueserinfo”: “personid”: “cbdf195ddd1c40efbd3c

38、48ca97c0cbe2”,“mobnum”: ,“birthday”: “,“gender”: “1”,“name”: “Testss10”,“usertype”: “5”,“credtype”: “0 “,“idcardno”: ,“fnascount”: 0,“userlogolist”: ,“account”: “Testss10” 獲取用戶好友接口說明應(yīng)用可以調(diào)用查詢用戶好友接口，在用戶授權(quán)的情況下，可以在福建省教育資源公共服務(wù)平臺上查詢用戶的好友信息。請求說明url:20001/aam/rest/queryFrien

39、dsReq?token=xxxxxxxx格式-協(xié)議Post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說明序號字段名約束類型長度說明1personid必選string64用戶ID2start可選String64查詢開始位置，不填默認為03end可選String64查詢結(jié)束位置，不填默認為104platformcode可選String64平臺區(qū)域碼 “personid”: “49659461d4094c7f830204175588e2ea”,“start”: “0”,“end”:“10”,“platformcode”:“100001”返回說明序號字段名約束類型長度說明1result

40、必選string6結(jié)果000000:成功301001:用戶不存在2start必選int查詢開始位置3end必選int查詢結(jié)束位置4count必選int總記錄條數(shù)5list可選成員信息列表5.1peronsid可選String32用戶id5.2account可選String20用戶名5.3name可選string32用戶姓名5.4connecthetime可選date32關(guān)注時間，我主動關(guān)注他的時間5.5connectmetime可選string100關(guān)注時間，他關(guān)注我的時間5.6userlogolist可選-頭像LOGO（URL地址）列表5.6.1logotype可選int1頭像類型：1：??；

41、2：中；3：大；5.6.2logourl可選string512頭像LOGO（URL地址）返回結(jié)果例子“retcode”:“000000”, “count”:“2”,“start”:“0”,“end”:“10”,“l(fā)ist”: “personid”:“1289301erwopUJYHDW24”,“areacode”:“510000”“mobNum“: ,“email”: “123456”,“name”: “test”, “personid”:“1289301erwopUJYHDW23”,“areacode”:“510000”“mobNum“:

42、,“email”: “1234567”,“name”: “test2” ,驗證用戶是否為好友接口說明應(yīng)用可以調(diào)用驗證用戶是否為好友接口，驗證是否為好友請求說明url :22015/aam/rest/validaFriendsReq?token=xxxxxxxx格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說明序號參數(shù)名稱是否必須類型描述1personid必須String用戶id2friendid必選String好友的用戶id3platformcode可選String平臺區(qū)域碼返回說明返回碼含義說明000000驗證成功，為好友關(guān)系301001用戶不存在3011

43、22好友不存在字段說明字段名約束類型說明result必選string返回碼desc可選String返回消息說明返回結(jié)果例子“result”:“000000”, “desc”:“驗證成功” 查詢班級信息接口描述根據(jù)班級ID查詢班級信息請求說明url:20001/aam/rest/queryClassInfoReq?token=xxxxxxxx支持驗證方式格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向展現(xiàn)平臺參數(shù)說明序號字段名約束類型長度說明1classids必選Json數(shù)組-班級id的JSON數(shù)組，一個或多個2platformcode可選String6平臺編碼classi

44、ds:00d81f28cdbf412c8757a3b92ffeed48,19e0f91aaf224fb28a712537418a379c,5e5ed67bc84b4b10ba5bce8d4bd12385,platformcode:000000返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:查詢成功2desc可選 string50返回描述3classinfolist可選班級信息JSON數(shù)組3.1classid可選string32班級ID3.2orgaid可選string32所屬機構(gòu)/學(xué)校編號3.3classname可選string50班級名稱3.4gradec

45、lass可選int2班別相應(yīng)的數(shù)字，代表相應(yīng)班別，如：1代表1班3.5grade可選int2年級1:一年級2：二年級3：三年級4：四年級5：五年級6：六年級7：初一8：初二9：初三10：高一11：高二12：高三3.6foundtime可選string32成立年份3.7created可選string32創(chuàng)建時3.8membercount可選int6成員數(shù)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支持驗證方式格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向展現(xiàn)平臺參數(shù)說明序號字段名約束類型長度說明1classid必選string-班級id 2start必選int記錄開始數(shù)3end必選int記錄結(jié)束數(shù)4platformcode可選string平臺編碼 中央平臺：000000示例：classid

48、:00d81f28cdbf412c8757a3b92ffeed48,“start”:”0”,end:10,platformcode:000000,返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:成功2start必選int查詢開始位置3end必選int查詢結(jié)束位置4count必選int總記錄條數(shù)5userinfo可選5.1personid必選string60用戶的統(tǒng)一ID；5.2mobnum可選string16手機號碼5.3email可選string16郵箱5.4name可選string32用戶姓名5.5usertype必選string1用戶類型學(xué)生:0老師:

49、15.6teachesubjectlist可選 Json數(shù)組50如用戶為教師，則返回所教學(xué)科，JSON數(shù)組5.6.1subjectid可選String32學(xué)科id5.6.2subjectname可選String50學(xué)科名稱5.6.3teachmaterialid可選string32教材id5.6.4teachmaterialname可選String200教材名稱用戶登錄（C/S模式應(yīng)用）接口描述C/S系統(tǒng)調(diào)用該接口實現(xiàn)用戶帳號登錄，密碼可以是靜態(tài)密碼也可以是動態(tài)密碼。請求說明url HYPERLINK /aam/rest/account/login :20001/aam/rest/accoun

50、t/login?token=xxxxxxxx支持驗證方式格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用AAM參數(shù)說明序號字段名約束類型長度說明1account必選string128注冊賬號。2password必選string32靜態(tài)密碼或動態(tài)密碼；靜態(tài)密碼加密方式：MD5加密后字母字符為大寫的字符串，再經(jīng)過RC4加密(加密的密鑰user_sercretkey)；密碼經(jīng)過加密后再傳輸；動態(tài)密碼登錄時，為明文。當采用靜態(tài)密碼或動態(tài)密碼方式認證時，必選。3passwdtype可選string4密碼類型：默認是00：靜態(tài)密碼1：動態(tài)密碼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訂購結(jié)果000000:成功301001:用戶不存在2desc可選string250結(jié)果描述3tgcticke可選Str

52、ing64永久Ticket，唯一標識一個登錄用戶4usessionid可選String64唯一標識一個登錄用戶sessionid5ueserinfo可選5.1personid必選string60用戶的統(tǒng)一ID；5.2mobnum可選string16手機號碼5.3email可選string16郵箱5.4name可選string32用戶姓名5.5nickname可選string100昵稱5.6areacode可選string64用戶歸屬地區(qū)域5.7name可選string16姓名5.8gender可選string1性別0是女，1為男5.9birthday可選date16生日5.10usertype

53、必選string1用戶類型:學(xué)生:0老師:1家長:2機構(gòu):3學(xué)校：4學(xué)校工作人員：5機構(gòu)工作人員：65.11address可選string256通訊地址5.12postcode可選string8郵編5.13userlogolist可選-頭像LOGO（URL地址）列表5.13.1logotype可選int1瀏覽渠道：1：?。?：中；3：大；5.13.2logourl可選string512頭像LOGO（URL地址）5.14interests可選string512興趣，多個興趣之間用分號分開5.15profession可選string64職業(yè)5.16credtype可選string10：身份證1:護

54、照2:軍人證3:其他5.17idcardno可選string32證件號碼5.18singature可選string140簽名5.19fnascount可選int 粉絲數(shù)5.20teachesubjectlist可選 Json數(shù)組50如登錄用戶為教師，則返回所教學(xué)科，JSON數(shù)組5.20.1subjectid可選String32學(xué)科id5.20.2subjectname可選String50學(xué)科名稱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數(shù)組2用戶所在班級身份: 1:班主任 2：班長 3：管理員4: 教師 5：成員 6：教研員，7：教務(wù)員，8：信息員5.24orgaid可選string32用戶所在機構(gòu)學(xué)校id5.25organame可選string200用戶所在機構(gòu)學(xué)校名稱5.26orgaidentity可選string2用戶在機構(gòu)身份：1:管理員2

56、：成員3：教研員；4：教務(wù)員；5：信息員，5.27tags可選string1000個人標簽5.28areacode可選string8所在地區(qū)編碼查詢班級列表接口描述根據(jù)機構(gòu)ID或班級ID查詢班級列表請求說明url:20001/aam/rest/queryClassInfoListReq?token=xxxxxxxx支持驗證方式格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說明序號字段名約束類型長度說明1orgaid可選string64可為機構(gòu)ID、學(xué)校ID2start可選string20查詢開始記錄下標3end可選string30查詢結(jié)束記錄下標4class

57、ids可選String20班級id的JSON數(shù)組，一個或多個5platformcode可選String平臺編碼返回說明序號字段名約束類型長度說明1result必選string6結(jié)果000000:成功2start必選String8查詢開始位置3end必選String8查詢結(jié)束位置4count必選String8總記錄條數(shù)5classinfolist可選班級信息列表5.1classid可選string32班級ID5.2orgaid可選string32所屬機構(gòu)/學(xué)校編號5.3classname可選string20班級名稱5.4gradeclass可選int班別相應(yīng)的數(shù)字，代表相應(yīng)班別，如：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邀請權(quán)限；1：成員可邀請其他人加入2：只有班主任或班長邀請加入5.10created可選string32創(chuàng)建時間5.11membercount可選int成員數(shù)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數(shù)組5.15.1personid可選string32用戶ID5.15.2nam

60、e可選string10姓名5.16classalises可選string50班級別名5.17flagpic可選string256班級標識圖片(URL)5.18classcate可選string1班級類型0：普通班1：實驗班查詢班級學(xué)生接口描述查詢學(xué)校班級學(xué)生請求說明urlHYPERLINK 1:16001/aam/rest/queryClassStudentReq:20001/aam/rest/queryClassStudentReq?token=xxxxxxxx支持驗證方式-格式j(luò)son協(xié)議post是否需要鑒權(quán)true請求數(shù)限制true接口方向應(yīng)用平臺參數(shù)說明序號字段名約束類型長度說明1sc