




版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領
文檔簡介
DB4401ICS35.240.01DB4401CCSL67廣 州 市 地 方 標 準DB4401/T223—2023教育電子學習資源數據接口規(guī)范Specificationofdatainterfaceforeducationale-learningresources2023-2023-080520230905廣州市市場監(jiān)督管理局發(fā)布DB4401/T223—2023目 次前言 III引言 V范圍 1規(guī)范性引用文件 1術語和定義 1接口數據模型及數據分類代碼 1接口數據模型 1數據分類代碼 5數據接口要求 13接口訪問流程 13接口協(xié)議 13公共參數 13對象模型 17接口對象模型 17接口API 19附錄A(資料性)sha1加密代碼實現(Java) 22附錄B(資料性)數據接口示例 23參考文獻 27IDB4401/TXXXXX—2023IIDB4401/TXXXXX—2023IIDB4401/T223—2023DB4401/T223—2023前 言本文件按照GB/T1.1—2020《標準化工作導則第1部分:標準化文件的結構和起草規(guī)則》的規(guī)定起草。請注意本文件的某些內容可能涉及專利。本文件的發(fā)布機構不承擔識別專利的責任。本文件由廣州市教育局提出并歸口。本文件起草單位:廣州市電化教育館、廣州市標準化研究院、廣州市越秀區(qū)市場監(jiān)督管理局。本文件主要起草人:鐘毅、孫立杰、彭斌、霍迎輝、鄭勇、羅杰明、肖勁峰。IIIIIIDB4401/TXXXXX—2023IVDB4401/TXXXXX—2023IVDB4401/T223—2023DB4401/T223—2023引 言VVDB4401/T223—2023DB4401/T223—2023DB4401/T223—2023DB4401/T223—2023教育電子學習資源數據接口規(guī)范范圍本文件規(guī)定了教育電子學習資源數據接口的數據模型、數據分類代碼和數據接口要求。規(guī)范性引用文件GB/T4880.1—2005語種名稱代碼第1部分:2字母代碼GB/T7408—2005數據元和交換格式信息交換日期和時間表示法GB/T28825—2012信息技術學習、教育和培訓學習對象分類代碼JY/T0607—2017基礎教育教學資源元數據信息模型中國圖書館圖書分類法(第五版)術語和定義下列術語和定義適用于本文件。3.1教育電子學習資源educationale-learningresources在教學過程中使用的多種格式的電子文件。3.2數據接口datainterface數據平臺內或平臺之間不同組成部分銜接通訊的約定。接口數據模型及數據分類代碼接口數據模型接口數據模型依據JY/T0607—2017建立,如表1所示。1表1接口數據模型序號數據名稱數據類型數據長度(字符)備注示例1標題,title多語言字符串1000該資源的描述的名字記錄語種,language_code字符串類法(第五版)GB/T4880.1—2005中選取220“zh”“en”“fr-CA”3其他標題,alternativetitle多語言字符串1000正式標題之外的其他名稱或替代寫法固山下》賞析”描述,description多語言字符串以文本方式對資源內容的簡介“通過基礎知識識?!?20005關鍵字,keyword多語言字符串1000用以描述資源主要內容的關鍵詞語“氣密性”6版本,version多語言字符串50該資源所屬學科課文版本“Demo”“公開測試版”學習方式,learningmode多語言字符串該資源所適用的學習行為,體現學生在自主性、探究性和合作性方面的基本特征71008用戶類型,audience字符串200該資源的主要使用者,最重要的優(yōu)先列出“學齡前兒童”9課程標準,curricularstandard字符串1000描述該資源與國家課程標準內容框架的對應關系10教材目錄,textbookcode字符串1000描述該資源與教材內容框架對應關系11專題教育資源代碼,specialsubject_code字符串100在實施教育教學的過程中,專門研究或討論的題目22表1接口數據模型(續(xù))序號數據名稱數據類型數據長度(字符)備注示例12來源,source字符串1000該資源引用的訪問互聯(lián)網地址“/”13作者,author多語言字符串100發(fā)布該資源的作者姓名記錄14主講人,instructor多語言字符串100該資源中的主講人的姓名記錄15作者所在單位,authorc多語言字符串100該資源創(chuàng)建者的所在單位名字記錄16作者所在單位代碼,authorc_code字符串100該資源創(chuàng)建者的所在單位名字代碼,使用廣州市中小學的學校代碼(廣州市中小學學籍數據庫中各個單位唯一代碼)17作者所在區(qū)域或縣代碼,author_Area_code多語言字符串100該資源作者所在區(qū)域或縣代碼18作者所在省份代碼,authorp_code多語言字符串100該資源作者所在省份代碼19作者所在城市代碼,authorcity_code多語言字符串100該資源作者所在城市代碼20課程內容分類代碼,knowledge_code多語言字符串300該資源所屬知識點標識代碼,根據JY/T0607—2017選取21視頻節(jié)點,vediopoint字符串100視頻資源節(jié)點時間戳22語音節(jié)點,voicepoint字符串100語音資源節(jié)點時間戳23學段代碼,interval_code字符串100該資源所屬學段24年級代碼,grade_level_code字符串100該資源所屬年級代碼25學科代碼,curricular_code字符串100該資源所屬學科代碼33表1接口數據模型(續(xù))序號數據名稱數據類型數據長度(字符)備注示例26版本,version多語言字符串100該資源所屬學科課文版本27冊數,volume多語言字符串100該資源所屬學科課文冊28單元,unit多語言字符串300該資源所屬學科課文單元名稱29章,chapter多語言字符串300該資源所屬學科課文章名稱30節(jié),part多語言字符串300該資源所屬學科課章節(jié)名稱31創(chuàng)建時間,createdtime日期時間按GB/T7408—2005相關要求該資源創(chuàng)建時間“2020-06-16”32下載總數,downloadsum字符串100該資源被下載總量33點擊總數,clicksum字符串100該資源被點擊總量34收藏總數,collectsum字符串100該資源被收藏總量35資源類型,codelearning_resource_type_code字符串100該資源所屬資源的類型代碼36資源格式,codeformat_code字符串100格式分類代碼引用GB/T288252012中媒體格式分類代碼37資源大小,size字符串30資源所需計算機存儲容量,該數據表明資源的實際大小“2500”38出版社,publisher多語言字符串100該資源對應課程的出版社39其他作者,authoretc多語言字符串300該資源的其他作者40摘要,abstract多語言字符串2000該資源的簡要描述41二維碼描述,2D字符串300該資源所在訪問鏈接二維碼描述44表1接口數據模型(續(xù))序號數據名稱數據類型數據長度(字符)備注示例42存儲地址,address多語言字符串300該資源存儲的計算機網絡訪問地址“http:///1.ppt”43資源分類代碼,Resourceclassificationcode字符串100該資源屬于的分類描述44關聯(lián)類型代碼,relationship_code字符串8描述該資源與關聯(lián)資源之間的關系45關聯(lián)描述,relationship_description字符串300關聯(lián)資源的描述數據分類代碼語種分類代碼從《中國圖書館圖書分類法(第五版)》和GB/T4880.1—2005選取,如表2所示。表2語種分類代碼代碼語言名稱語種代碼H1漢語zhH212蒙古語mnH214藏語boH215維吾爾語ugH216苗語——H217彝語——H218壯語zaH219朝鮮語koH236哈薩克語(撒里維吾爾語)kkH31英語enH32法語frH33德語deH34西班牙語esH35俄語ruH36日語jaH37阿拉伯語arH9其他qt4.2.2學習方式分類代碼4.2.2學習方式分類代碼54.2.4專題教育分類代碼4.2.4專題教育分類代碼專題教育資源分類代碼按照《中國圖書館圖書分類法(第五版)》類目簡表和JY/T0607—2017,結合基礎教育資源實際編制而成,如表5所示。表5專題教育分類代碼6學習方式分類代碼如表3所示。表3學習方式分類代碼代碼類型備注L01講授L02探究L03自學L04合作L09其他4.2.3用戶類型分類代碼用戶類型分類代碼如表4所示。表4用戶類型分類代碼代碼類型備注A01學生A02教師A03教育管理員A04家長A05未入學青少年A09其他用戶代碼類型備注SS01社會主義核心價值觀教育SS02法制教育SS03行為養(yǎng)成教育SS04安全教育SS05心理健康教育SS06國防教育SS07體育與健康教育SS08民族團結教育SS09藝術教育SS10科普教育表5專題教育分類代碼(續(xù))代碼類型備注SS11家庭教育SS12學校管理SS13勞動教育SS14地方教育SS15德育教育SS99其他教育年級分類代碼按照GB/T28825—2012中適用對象分類代碼,如表6所示。表6年級分類代碼代碼名稱備注ON正規(guī)教育ON01學前ON0101000~2歲ON0102003~6歲ON02小學ON020100小學一年級ON020200小學二年級ON020300小學三年級ON020400小學四年級ON020500小學五年級ON020600小學六年級ON03初中ON030100初中一年級(七年級)ON030200初中二年級(八年級)ON030300初中三年級(九年級)ON04高中ON040100高中一年級ON040200高中二年級ON040300高中三年級ON05中等職業(yè)教育ON05100中等職業(yè)教育一年級ON05200中等職業(yè)教育二年級ON05300中等職業(yè)教育三年級ON09其他年級77學科分類代碼學科分類代碼按照GB/T28825—2012中學科分類代碼,如表7所示。表7學科分類代碼代碼名稱備注SB基礎學科SB01語言與文字SB0101語文SB0102英語SB0103俄語SB0104日語SB0105德語SB0106法語SB0107其他外語SB0108中國少數民族語文SB0201數學SB03人文與社會科學SB0301政治SB0302思想品德SB0303品德與生活SB0304品德與社會SB0305社會SB0306歷史與社會SB0307歷史SB0308地理SB04自然科學SB0401物理SB0402化學SB0403生物SB0404科學SB05技術SB0501勞動與技術教育SB0502信息技術SB0503職業(yè)教育SB0504通用技術88表7學科分類代碼(續(xù))代碼名稱備注SB0601藝術SB0602音樂SB0603美術SB0701體育SB0702體育與健康SB08綜合實踐活動SB0801綜合實踐活動SB0802研究性學習SB0803社區(qū)服務與社會實踐SB09跨區(qū)域的學習活動SB10人工智能SB11勞動實踐SB99其他課程資源類型分類代碼如表8所示。表8資源類型分類代碼9資源類型分類代碼如表8所示。表8資源類型分類代碼9代碼資源類型子類型RT01教學素材—RT02網絡課程—RT0201—微課RT0202—慕課RT0203—網校課程RT03虛擬仿真系統(tǒng)—RT04教育游戲—RT05教學案例—RT0501—教學設計RT0502—課堂實錄RT0503—教學課件RT0504—導學RT0599—其他RT06數字圖書—RT07數字教材—RT08教學工具—表8資源類型分類代碼(續(xù))代碼資源類型子類型RT09學習網站—RT10習題—RT1001—練習RT1002—章節(jié)測試RT1003—期中期末考試RT1004—中高考RT11課標解讀—RT12教材教法分析—RT13實驗—RT99其他—格式分類代碼按照GB/T28825—2012中媒體格式分類代碼,如表9所示。表9格式分類代碼代碼名稱備注F0文本格式F001TXT(TextFile)F002RTF(RichTextFormat)F003DOCF004ODF(OpenDocumentFormat)F005UOF(UnifiedOfficeDocumentFormat)F006PDF(PortableDocumentFormat)F007UMD(UniversalMobileDocument)F008HTML(HyperTextMarkupLanguage)F009XML(ExtensibleMarkupLanguage)F010XPS(XMLPaperSpecification)F011PPT(PowerPoint)F012WPSF013EIOF015CLLF016PostscriptF017WordPerfectF099其他文本格式F1音頻格式F101WAV(Wave)1010表9格式分類代碼(續(xù))代碼名稱備注F102MP3(MPEGAudioLayer3)F103RA(RealAudio)F104MIDI(MusicalInstrumentDigitalInterface)F105WMA(WindowsMediaAudio)F106WAMF107OGG(OggVorbis)F108AIFF(AudioInterchangeFileFormat)F109FLAC(FreeLosslessAudioCode)F110SND(Sound)FI11VOC(Voice)F112MOD(Module)F113S3M(ScreamtrackerModules)F114XM(XpressMusic)F115MTMF116FARF117KARF118CD(CompactDisc)F119VQF(transform-domainweightedInterleaveVectorQuantization)F120ASF(AdvancedStreamingFormat)F121RM(RealMedia)F122APEF123AVSF124MP4(MPEG-4Part14)F199其他音頻格式F2視頻格式F201MPEG(MovingPicturesExpertsGroup)F202AVI(AudioVideoInterleaved)F203RV(RealVideo)F204RM(RealMedia)F205RMVB(RealMediaVariableBitrate)F206WMV(WindowsMediaVideo)F207ASF(AdvancedSystemsFormat)F208MOVF209DIVF210DIVXF211FLV(FlashVideo)F212DVD(DigitalVersatileDisc)F213VCD(VideoCompactDisc)1111表9格式分類代碼(續(xù))代碼名稱備注F2143GPF215DAT(Data)F216RA(RealAudio)F217RAM(RandomAccessMemory)F299其他視頻格式F3圖形/圖像F301JPEG(JointPhotographicExpertsGroup)F302GIF(GraphicsInterchangeFormat)F303BMPF304TIFF(TaggedImageFileFormat)F305PNG(PortableNetworkGraphicFormat)F306WMFF307PSDF308PCDF309PCXF310EPS(EncapsulatedPostScript)F311CGM(ComputerGraphicsMetafile)F312EXIF(ExchangeableImageFile)F313TGA(TaggedGraphics)F314FPXF315SVG(ScalableVectorGraphics)F316CDRF317DXF(DrawingExchangeFormat)F318EPG(ElectronicProgramGuide)F399其他圖形/圖像格式F4動畫F401SWF(ShockWaveFlash)F402GIF(GraphicsInterchangeFormat)F403MKVF499其他動畫格式F9其他格式4.2.9關聯(lián)類型分類代碼4.2.9關聯(lián)類型分類代碼關聯(lián)類型分類代碼如表10所示。12表10關聯(lián)類型分類代碼代碼類型內容示例RS01部分/全部關聯(lián)一種資源是另一種資源的物理或邏輯的一部分IsPartOf組成部分HasPart部分為RS02版本關聯(lián)一種資源是一個歷史的敘述或同一創(chuàng)建者的另一資源的版本IsVersionOf版本繼承HasVersion版本關聯(lián)RS03格式轉換關聯(lián)它不是一種解釋而是一種再現IsFormatOf格式轉換于HasFormat格式轉換為RS04參照關聯(lián)某一資源的作者認可、引用、爭論或提及另一種資源IsReferencedBy被參考References參考RS05創(chuàng)造性關聯(lián)釋IsReplacedBy被替代Replaces替代RS06附屬關聯(lián)一種資源需要另一種資源產生效用,并表達或反映內容IsRequiredBy被需求Requires需求Conformanceto遵循數據接口要求所有接口統(tǒng)一按照HTTPPOST方式傳遞JSON每一次數據請求為獨立請求,前后兩次請求之間沒有關聯(lián)。所有接口統(tǒng)一按照HTTPPOST方式傳遞JSON每一次數據請求為獨立請求,前后兩次請求之間沒有關聯(lián)。接口協(xié)議RESTHTTPGETPOSTGETURL(QueryParam)提供。POSTURL(QueryParam)JSON公共參數接口的請求和返回均包含規(guī)定的公共參數,如無特殊說明,所有接口方法都應包含以下請求公共參數以及返回公共參數。11表11請求公共參數13參數名必選數據類型長度備注access_token是String500訪問令牌,成功調用login接口后返回sign否String500請求參數簽名值(預留)sign_method否String500簽名方法(預留)5.3.45.3.41314表13錯誤信息結構14表11請求公共參數(續(xù))參數名必選數據類型長度備注timestamp否Date100應用程序發(fā)出請求的客戶端時間,大平臺在接收到請求后,與當前服務端時間比較,如果在誤差范圍大于10min,將請求視為無效request_id否String100應用程序發(fā)出請求的唯一標識號,大平臺如果在誤差時間內request_id外,其它請求將視為重放攻擊而被忽略5.3.312表12返回公共參數參數名必選數據類型長度備注ack_code是String10接口調用是否成功:SUCCESS:成功FAILURE:失敗errors否List<Error>500錯誤信息sign否String500請求參數簽名值(預留)sign_method否String500簽名方法(預留)timestamp否Date100接口響應的服務端時間correlation_id否String100request_idrequest_id在響應時會原樣返回response_id否String100接口返回的唯一標識號屬性必選數據類型長度備注code是String10錯誤代碼message是String4000錯誤信息描述inner_code否String50內部代碼表14錯誤代碼說明錯誤代碼錯誤說明原因分析處理方式11001缺少access_token參數檢查程序是否正確提供了access_token參數所有接口方法(除login外)應提供有效的access_token11002缺少app_key參數檢查程序是否正確提供了app_key參數錯誤需檢查接口通訊情況11003缺少sign參數提供了sign_method參數,但沒有提供sign參數sign_method或者提供sign參數11004缺少sign_method參數提供了sign參數,但沒有提供sign_method參數建議去掉sign參數采用不簽名方式,或者提供sign_method參數11005缺少timestamp參數提供了request_id參數但沒有提供timestamp參數建議去掉request_id參數或者提供timestamp參數11100~11199缺少第xx個應用參數參考接口說明,按規(guī)定提供必須的參數101011數(公共輸入參數不計算在內)12001access_token無效產生此錯誤的原因是會話尚未得到授權或者已經超時或者已被注銷建議重新調用login方法創(chuàng)建一個新的授權會話12002app_key無效表示當前程序不是合法的應用程序建議申請獲得一個有效的app_key12003簽名校驗失敗檢查簽名方法是否正確,并測試在發(fā)送請求前自行進行簽名驗證如果檢查無誤仍然有此錯誤,有可能請求在發(fā)送過程中被篡改12004不支持的簽名方法參數配置錯誤改用接口支持的簽名方法12005請求時間超過誤差范圍互聯(lián)雙方互聯(lián)通信超時問題運行應用程序的客戶端時間與接口服務端10min間;運行應用程序的客戶端與接口服務端之間中捕獲此錯誤并重新調用。12006收到重復的請求參數配置錯誤因為程序錯誤導致在多次調用中產生了相request_id;由于網絡原因請求被偶然重發(fā),建議排查網絡問題或直接略忽;請求被記錄并重放,建議排查網絡安全問題。12100~12199第xx個應用參數不合法如出現錯誤代碼,例如類型不匹配請按照接口說明傳入正確的參數值13001第三方應用程序未獲得授權調用指定方法表示所提供的app_key是有效的,但未獲得授權調用指定的接口方法如確實需要調用此方法,請向平臺管理員申請授權1515表14錯誤代碼說明(續(xù))錯誤代碼錯誤說明原因分析處理方式13002會話未獲得授權調用指定方法當前會話上下文無權限執(zhí)行相應的操作例如以部分管理員身份創(chuàng)建的會話中,無權新建一個部門,建議檢查是否使用了正確的用戶身份創(chuàng)建會話13003所操作的對象超出當前會話的可管理范圍參數配置錯誤例如以A部門管理員身份創(chuàng)建的會話中,執(zhí)行對B部門下的事項操作,將返回此錯誤,建議檢查是否使用了正確的用戶身份創(chuàng)建會話14101調用getXXX方法時找不到相應對象參數配置錯誤可能用來判斷是否存在此對象,建議調用getXXX空對象進行操作14110~14199調用getXXX方法時遇到的其它錯誤參數配置錯誤參照具體接口方法的說明14210~14299調用listXXX方法時遇到的錯誤參數配置錯誤參照具體接口方法的說明14301創(chuàng)建對象時主鍵或具有唯一性的屬性重復參數配置錯誤檢查待創(chuàng)建對象的主鍵(對象代碼)或具有唯一性的屬性是否符合規(guī)范14302創(chuàng)建對象時不允許空屬性沒有賦值參數配置錯誤檢查待創(chuàng)建對象中不允許空的屬性14303創(chuàng)建對象時部分屬性不符合規(guī)范參數配置錯誤例如格式不正確,超出值域等14310~14399創(chuàng)建對象時遇到的其它錯誤參數配置錯誤參照具體接口方法的說明14401更新對象時主鍵或具有唯一性的屬性重復參數配置錯誤檢查待更新對象的主鍵(對象代碼)或具有唯一性的屬性是否符合規(guī)范14402更新對象時不允許空屬性沒有賦值參數配置錯誤檢查待更新對象中不允許空的屬性14403更新對象時部分屬性不符合規(guī)范參數配置錯誤例如格式不正確,超出值域等14410~14499更新對象時遇到的其它錯誤參數配置錯誤參照具體接口方法的說明14501要刪除的對象不存在參數配置錯誤建議在刪除對象之前先調用getlist確認對象存在14502子對象不為空,無法刪除主對象參數配置錯誤除接口有特殊說明外,在刪除對象前應先刪除所有子對象14503待刪除的對象存在引用,不能刪除在刪除對象時,應先移除所有對該對象的引用關系例如在刪除一個服務窗口前,應保證所有引用該窗口的事項中移除相應的引用關系14510~14599在刪除對象時遇到的其它錯誤參數配置錯誤參照具體接口方法的說明1616表14錯誤代碼說明(續(xù))錯誤代碼錯誤說明原因分析處理方式建議應用程序間隔一段時間后再自動嘗試重19000~19999示接口服務端或客戶端程序出現不可預測的內結果。偶然出現此類錯誤復后的通知,再協(xié)助進行后續(xù)的處理。5.3.5SignppKey、timestamp、randomNum、appSecresha115表15額外參數屬性必選數據類型長度備注appSecret是string500APP應用密鑰,由網關方提供(自行保存,不可泄露)字符串順序規(guī)則字符串順序規(guī)則字符串順序規(guī)則:appSecret+randomNum+appKey+timestamp+appSecret。sha1Java)sha1加密代碼實現(Java)見附錄A。接口調用過程loginaccess_token調用安全會話接口的login方法,以部門管理員賬戶創(chuàng)建會話獲取訪問令牌access_token,請求示例見附錄B中B.1.1。access_tokenAPI把access_token作為請求的公共參數來調用接口API,示例見附錄B中B.1.2。logout調用安全會話接口的logout方法,設置access_token為無效,示例見附錄B中B.1.3。5.5對象模型17UserInfo(用戶信息類16表16UserInfo(用戶信息類)屬性必選長度類型備注account是100String賬戶名稱,標識屬性name是100String用戶姓名identity_num否20String身份證件號碼division是256String行政區(qū)劃名稱,只讀屬性division_code是20String行政區(qū)劃代碼,只讀屬性service_org是256ServiceOrg所屬機構,只讀屬性extend_props否4000String擴展屬性creator否100String創(chuàng)建者creation_time是100Date創(chuàng)建時間last_modificator否100String最后修改者last_modification_time是100Date最后修改時間ResourceInfo(資源信息類17表17ResourceInfo(資源信息類)屬性必選長度類型備注title是1000變長類型標題language_code是20變長類型語種alternativetitle否1000變長類型其他標題description否2000變長類型描述keyword否1000變長類型關鍵字version是50變長類型版本learning_mode否100變長類型學習方式audience是200變長類型用戶類型curricular_tandard是1000變長類型課程標準textbook_code否1000變長類型教材目錄special_subject否100變長類型專題教育資源source否1000變長類型來源author是100變長類型作者instructor否100變長類型主講人authorc是100變長類型作者所在單位authorc_code是100變長類型作者所在單位代碼author_area_code是100變長類型作者所在區(qū)域或縣代碼authorp_code是100變長類型作者所在省份代碼authorcity_code是100變長類型作者所在城市代碼1818表17ResourceInfo(資源信息類)(續(xù))屬性必選長度類型備注knowledge_code否300變長類型課程內容分類代碼vediopoint否100時間類型視頻節(jié)點voicepoint否100時間類型語音節(jié)點interval_code是100變長類型學段代碼grade_level_code是100變長類型年級代碼curricular_code是100變長類型學科代碼version是100變長類型版本volume是100變長類型冊數unit是300變長類型單元chapter是300變長類型章part是100變長類型節(jié)createdtime是100時間類型創(chuàng)建時間downloadsum否100整數值型下載總數clicksum否100整數值型點擊總數collectsum否100整數值型收藏總數learning_resource_type_Code是100變長類型資源類型format_Code是100變長類型資源格式size是30數值型資源大小publisher否100變長類型出版社authoretc否300變長類型其他作者abstract是2000變長類型摘要2D否100變長類型二維碼描述address否300變長類型存儲地址relationship_code否8變長類型關聯(lián)類型代碼Relationship_de否300變長類型關聯(lián)類型描述APIsecurity/login.do方法名稱:login。方法說明:通過用戶名和密碼進行身份驗證,驗證成功后創(chuàng)建一個會話。所有對數據和附件的管理操作都應在有效的會話內進行。請求方法:POST。URLhttp://{API_ROOT}/security/login.do。訪問權限:所有通過授權的第三方程序。1819請求示例見附錄B中B.2.1。返回示例見附錄B中B.2.2。請求示例見附錄B中B.2.1。返回示例見附錄B中B.2.2。security/logout.do方法名稱:logout。方法說明:注銷當前會話。請求方法:POST。URLhttp://{API_ROOT}/security/logout.do。訪問權限:所有已登錄用戶。請求參數:無。返回結果:無。BB.2.3。BB.2.4。security/get_current_user.do方法名稱:get_current_user。方法說明:獲取當前已登錄用戶的信息。請求方法:GET。URL地址:http://{API_ROOT}/security/get_current_user。訪問權限:所有已登錄用戶。請求參數:無。2020表18請求參數參數名必選數據類型長度備注app_key是String500分配給應用程序的app_keyapp_secret是String500分配給應用程序的app_secretaccount是String500用戶賬戶名稱password是String500用戶賬戶密碼org_code否String500以指定的部門管理員身份登錄19表19返回結果參數名必選數據類型長度備注access_token是String500登錄成功則返回安全會話訪問令牌expires_in是Integer500訪問令牌超時時間(以秒為單位),缺省24hsuccess否String500登錄標識msg否String500登錄成功信息attributes是Map<String,Object>500返回的數據22表22返回結果BB.2.7。BB.2.8。21表20返回結果參數名必選數據類型長度備注attributes是TSUser500用戶信息success否String500登錄標識msg否String500登錄成功信息請求示例見附錄B中B.2.5。返回示例見附錄B中B.2.6。data_subject/list.do方法名稱:list。方法說明:根據設置條件(支持標題、作者、用戶類型等)查詢數據主題信息。如:查詢標題包含“三角形”資源。請求方法:POST。URLhttp://{API_ROOT}/data_subject/list。訪問權限:所有已登錄用戶。21表21請求參數參數名必選數據類型長度備注title否String1000標題author否String100作者audience否String200用戶類型參數名必選數據類型長度備注total_count否Integer100記錄數data否List<DataSubjectInfo>50資源詳細描述信息附錄A(資料性)sha1加密代碼實現(Java)importjava.nio.charset.StandardCharsets;importjava.security.MessageDigest;publicclassDigestSha{publicstaticvoidmain(String[]args){//使用方法StringappSecret="1";StringrandomNum="2";StringappKey="3";Stringtimestamp="4";DigestShaa=newDigestSha();Stringsign=a.sha1(appSecret+randomNum+appKey+timestamp+appSecret);System.out.println(sign);}publicStringsha1(Stringdata){MessageDigestmessageDigest;try{byte[]dataByte=data.getBytes(StandardCharsets.UTF_8);messageDigest=MessageDigest.getInstance("SHA-1");messageDigest.update(dataByte);byte[]finalDataByte=messageDigest.digest();char[]toDigits={'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'};finalintlen=finalDataByte.length;finalchar[]out=newchar[len<<1];for(inti=0,j=0;i<len;i++){//高位out[j++]=toDigits[(0xF0&finalDataByte[i])>>>4];//低位out[j++]=toDigits[0x0F&finalDataByte[i]];}returnnewString(out);}catch(Exceptione){thrownewRuntimeException(e);}}}22附錄B(資料性)接口調用過程示例下面給出了調用login創(chuàng)建安全會話登錄獲取access_token的示例。POSThttp://{API_ROOT}/security/login.doContent-Type:application/json{"app_key":"APP_KEY","app_secret":"APP_SECRET","account":"ACCOUNT","password":"PASSWORD"}返回結果:POSThttp://{API_ROOT}/security/login.doContent-Type:application/json{"app_key":"APP_KEY","app_secret":"APP_SECRET","account":"ACCOUNT","password":"PASSWORD"}返回結果:{"success":true,"msg":"登陸成功!","obj":null,"attributes":{"access_token":"4028098184325ff2018432a1f22c0002","expires_in":86400}}下面給出了使用access_token調用接口API的示例。GET http://{API_ROOT}/security/get_current_user.do?access_token=ACCESS_TOKEN返回結果:{GET http://{API_ROOT}/security/get_current_user.do?access_token=ACCESS_TOKEN返回結果:{"ack_code":"SUCCESS","msg":"獲取當前用戶成功","errors":[],"data":{"account":"gz_byq","name":"白云區(qū)用戶","identity_num":"440111************","service_org":"123456789","creator":"admin","creation_time":"2012-5-22","last_modificator":"admin","last_modification_time":"2012-5-22"}}2323{"success":true,"msg":"登陸成功!","obj":null,"attributes":{"success":true,"msg":"登陸成功!","obj":null,"attributes":{"access_token":"4028098184325ff2018432a1f22c0002","expires_in":86400}}POSThttp://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKENContent-Type:application/json{}下面給出了調用logout注銷會話的示例。POSThttp://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKENContent-Type:application/json返回結果:POSThttp://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKENContent-Type:
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經權益所有人同意不得將文件中的內容挪作商業(yè)或盈利用途。
- 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
- 6. 下載文件中如有侵權或不適當內容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- DB32/T 3761.18-2020新型冠狀病毒肺炎疫情防控技術規(guī)范第18部分:殯儀場所
- DB32/T 3714-2020三葉斑潛蠅測報技術規(guī)范
- DB32/T 3683-2019豬鏈球菌9型PCR檢測技術規(guī)程
- DB32/T 3579-2019農村產權交易農村小型公益性事業(yè)建設項目交易服務規(guī)范
- DB32/T 1321.5-2019危險化學品重大危險源安全監(jiān)測預警系統(tǒng)建設規(guī)范第5部分:施工條件與工程驗收
- DB31/T 773-2013房車旅游服務區(qū)基本要求
- DB31/T 726-2013高溫消防排煙風機安全、節(jié)能運行管理標準
- DB31/T 478.12-2011主要工業(yè)產品用水定額及其計算方法第12部分:建材行業(yè)(商品混凝土)
- DB31/T 1298-2021既有多層住宅加裝電梯安全技術要求
- DB31/T 1265-2020電動汽車充換電設施公共數據采集與監(jiān)測規(guī)范
- 【北京市人社局】2025年北京市人力資源市場薪酬數據報告(一季度)
- 醫(yī)院5s管理制度
- 2025年西藏自治區(qū)拉薩市城關區(qū)中考一模歷史試題(原卷版+解析版)
- 2025年濟南市中區(qū)九年級中考英語一模考試試題(含答案)
- 2025中學教師資格證《體育學科知識與教學能力》考前通關必練題庫-含答案
- 2025屆遼寧省丹東市高三總復習質量測試(一)生物試卷(原卷版+解析版)
- 2024中國人形機器人產業(yè)發(fā)展藍皮書1
- 食堂大廚考試試題及答案
- 調車作業(yè)培訓課件
- 違法用地違法建設培訓
- 玉盤二部合唱簡譜
評論
0/150
提交評論