DB4401T+223-2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范_第1頁
DB4401T+223-2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范_第2頁
DB4401T+223-2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范_第3頁
DB4401T+223-2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范_第4頁
DB4401T+223-2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范_第5頁
已閱讀5頁,還剩30頁未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

DB4401ICS35.240.01DB4401CCSL67廣 州 市 地 方 標(biāo) 準(zhǔn)DB4401/T223—2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范Specificationofdatainterfaceforeducationale-learningresources2023-2023-080520230905廣州市市場監(jiān)督管理局發(fā)布DB4401/T223—2023目 次前言 III引言 V范圍 1規(guī)范性引用文件 1術(shù)語和定義 1接口數(shù)據(jù)模型及數(shù)據(jù)分類代碼 1接口數(shù)據(jù)模型 1數(shù)據(jù)分類代碼 5數(shù)據(jù)接口要求 13接口訪問流程 13接口協(xié)議 13公共參數(shù) 13對(duì)象模型 17接口對(duì)象模型 17接口API 19附錄A(資料性)sha1加密代碼實(shí)現(xiàn)(Java) 22附錄B(資料性)數(shù)據(jù)接口示例 23參考文獻(xiàn) 27IDB4401/TXXXXX—2023IIDB4401/TXXXXX—2023IIDB4401/T223—2023DB4401/T223—2023前 言本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分:標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定起草。請(qǐng)注意本文件的某些內(nèi)容可能涉及專利。本文件的發(fā)布機(jī)構(gòu)不承擔(dān)識(shí)別專利的責(zé)任。本文件由廣州市教育局提出并歸口。本文件起草單位:廣州市電化教育館、廣州市標(biāo)準(zhǔn)化研究院、廣州市越秀區(qū)市場監(jiān)督管理局。本文件主要起草人:鐘毅、孫立杰、彭斌、霍迎輝、鄭勇、羅杰明、肖勁峰。IIIIIIDB4401/TXXXXX—2023IVDB4401/TXXXXX—2023IVDB4401/T223—2023DB4401/T223—2023引 言VVDB4401/T223—2023DB4401/T223—2023DB4401/T223—2023DB4401/T223—2023教育電子學(xué)習(xí)資源數(shù)據(jù)接口規(guī)范范圍本文件規(guī)定了教育電子學(xué)習(xí)資源數(shù)據(jù)接口的數(shù)據(jù)模型、數(shù)據(jù)分類代碼和數(shù)據(jù)接口要求。規(guī)范性引用文件GB/T4880.1—2005語種名稱代碼第1部分:2字母代碼GB/T7408—2005數(shù)據(jù)元和交換格式信息交換日期和時(shí)間表示法GB/T28825—2012信息技術(shù)學(xué)習(xí)、教育和培訓(xùn)學(xué)習(xí)對(duì)象分類代碼JY/T0607—2017基礎(chǔ)教育教學(xué)資源元數(shù)據(jù)信息模型中國圖書館圖書分類法(第五版)術(shù)語和定義下列術(shù)語和定義適用于本文件。3.1教育電子學(xué)習(xí)資源educationale-learningresources在教學(xué)過程中使用的多種格式的電子文件。3.2數(shù)據(jù)接口datainterface數(shù)據(jù)平臺(tái)內(nèi)或平臺(tái)之間不同組成部分銜接通訊的約定。接口數(shù)據(jù)模型及數(shù)據(jù)分類代碼接口數(shù)據(jù)模型接口數(shù)據(jù)模型依據(jù)JY/T0607—2017建立,如表1所示。1表1接口數(shù)據(jù)模型序號(hào)數(shù)據(jù)名稱數(shù)據(jù)類型數(shù)據(jù)長度(字符)備注示例1標(biāo)題,title多語言字符串1000該資源的描述的名字記錄語種,language_code字符串類法(第五版)GB/T4880.1—2005中選取220“zh”“en”“fr-CA”3其他標(biāo)題,alternativetitle多語言字符串1000正式標(biāo)題之外的其他名稱或替代寫法固山下》賞析”描述,description多語言字符串以文本方式對(duì)資源內(nèi)容的簡介“通過基礎(chǔ)知識(shí)識(shí)?!?20005關(guān)鍵字,keyword多語言字符串1000用以描述資源主要內(nèi)容的關(guān)鍵詞語“氣密性”6版本,version多語言字符串50該資源所屬學(xué)科課文版本“Demo”“公開測試版”學(xué)習(xí)方式,learningmode多語言字符串該資源所適用的學(xué)習(xí)行為,體現(xiàn)學(xué)生在自主性、探究性和合作性方面的基本特征71008用戶類型,audience字符串200該資源的主要使用者,最重要的優(yōu)先列出“學(xué)齡前兒童”9課程標(biāo)準(zhǔn),curricularstandard字符串1000描述該資源與國家課程標(biāo)準(zhǔn)內(nèi)容框架的對(duì)應(yīng)關(guān)系10教材目錄,textbookcode字符串1000描述該資源與教材內(nèi)容框架對(duì)應(yīng)關(guān)系11專題教育資源代碼,specialsubject_code字符串100在實(shí)施教育教學(xué)的過程中,專門研究或討論的題目22表1接口數(shù)據(jù)模型(續(xù))序號(hào)數(shù)據(jù)名稱數(shù)據(jù)類型數(shù)據(jù)長度(字符)備注示例12來源,source字符串1000該資源引用的訪問互聯(lián)網(wǎng)地址“/”13作者,author多語言字符串100發(fā)布該資源的作者姓名記錄14主講人,instructor多語言字符串100該資源中的主講人的姓名記錄15作者所在單位,authorc多語言字符串100該資源創(chuàng)建者的所在單位名字記錄16作者所在單位代碼,authorc_code字符串100該資源創(chuàng)建者的所在單位名字代碼,使用廣州市中小學(xué)的學(xué)校代碼(廣州市中小學(xué)學(xué)籍?dāng)?shù)據(jù)庫中各個(gè)單位唯一代碼)17作者所在區(qū)域或縣代碼,author_Area_code多語言字符串100該資源作者所在區(qū)域或縣代碼18作者所在省份代碼,authorp_code多語言字符串100該資源作者所在省份代碼19作者所在城市代碼,authorcity_code多語言字符串100該資源作者所在城市代碼20課程內(nèi)容分類代碼,knowledge_code多語言字符串300該資源所屬知識(shí)點(diǎn)標(biāo)識(shí)代碼,根據(jù)JY/T0607—2017選取21視頻節(jié)點(diǎn),vediopoint字符串100視頻資源節(jié)點(diǎn)時(shí)間戳22語音節(jié)點(diǎn),voicepoint字符串100語音資源節(jié)點(diǎn)時(shí)間戳23學(xué)段代碼,interval_code字符串100該資源所屬學(xué)段24年級(jí)代碼,grade_level_code字符串100該資源所屬年級(jí)代碼25學(xué)科代碼,curricular_code字符串100該資源所屬學(xué)科代碼33表1接口數(shù)據(jù)模型(續(xù))序號(hào)數(shù)據(jù)名稱數(shù)據(jù)類型數(shù)據(jù)長度(字符)備注示例26版本,version多語言字符串100該資源所屬學(xué)科課文版本27冊(cè)數(shù),volume多語言字符串100該資源所屬學(xué)科課文冊(cè)28單元,unit多語言字符串300該資源所屬學(xué)科課文單元名稱29章,chapter多語言字符串300該資源所屬學(xué)科課文章名稱30節(jié),part多語言字符串300該資源所屬學(xué)科課章節(jié)名稱31創(chuàng)建時(shí)間,createdtime日期時(shí)間按GB/T7408—2005相關(guān)要求該資源創(chuàng)建時(shí)間“2020-06-16”32下載總數(shù),downloadsum字符串100該資源被下載總量33點(diǎn)擊總數(shù),clicksum字符串100該資源被點(diǎn)擊總量34收藏總數(shù),collectsum字符串100該資源被收藏總量35資源類型,codelearning_resource_type_code字符串100該資源所屬資源的類型代碼36資源格式,codeformat_code字符串100格式分類代碼引用GB/T288252012中媒體格式分類代碼37資源大小,size字符串30資源所需計(jì)算機(jī)存儲(chǔ)容量,該數(shù)據(jù)表明資源的實(shí)際大小“2500”38出版社,publisher多語言字符串100該資源對(duì)應(yīng)課程的出版社39其他作者,authoretc多語言字符串300該資源的其他作者40摘要,abstract多語言字符串2000該資源的簡要描述41二維碼描述,2D字符串300該資源所在訪問鏈接二維碼描述44表1接口數(shù)據(jù)模型(續(xù))序號(hào)數(shù)據(jù)名稱數(shù)據(jù)類型數(shù)據(jù)長度(字符)備注示例42存儲(chǔ)地址,address多語言字符串300該資源存儲(chǔ)的計(jì)算機(jī)網(wǎng)絡(luò)訪問地址“http:///1.ppt”43資源分類代碼,Resourceclassificationcode字符串100該資源屬于的分類描述44關(guān)聯(lián)類型代碼,relationship_code字符串8描述該資源與關(guān)聯(lián)資源之間的關(guān)系45關(guān)聯(lián)描述,relationship_description字符串300關(guān)聯(lián)資源的描述數(shù)據(jù)分類代碼語種分類代碼從《中國圖書館圖書分類法(第五版)》和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學(xué)習(xí)方式分類代碼4.2.2學(xué)習(xí)方式分類代碼54.2.4專題教育分類代碼4.2.4專題教育分類代碼專題教育資源分類代碼按照《中國圖書館圖書分類法(第五版)》類目簡表和JY/T0607—2017,結(jié)合基礎(chǔ)教育資源實(shí)際編制而成,如表5所示。表5專題教育分類代碼6學(xué)習(xí)方式分類代碼如表3所示。表3學(xué)習(xí)方式分類代碼代碼類型備注L01講授L02探究L03自學(xué)L04合作L09其他4.2.3用戶類型分類代碼用戶類型分類代碼如表4所示。表4用戶類型分類代碼代碼類型備注A01學(xué)生A02教師A03教育管理員A04家長A05未入學(xué)青少年A09其他用戶代碼類型備注SS01社會(huì)主義核心價(jià)值觀教育SS02法制教育SS03行為養(yǎng)成教育SS04安全教育SS05心理健康教育SS06國防教育SS07體育與健康教育SS08民族團(tuán)結(jié)教育SS09藝術(shù)教育SS10科普教育表5專題教育分類代碼(續(xù))代碼類型備注SS11家庭教育SS12學(xué)校管理SS13勞動(dòng)教育SS14地方教育SS15德育教育SS99其他教育年級(jí)分類代碼按照GB/T28825—2012中適用對(duì)象分類代碼,如表6所示。表6年級(jí)分類代碼代碼名稱備注ON正規(guī)教育ON01學(xué)前ON0101000~2歲ON0102003~6歲ON02小學(xué)ON020100小學(xué)一年級(jí)ON020200小學(xué)二年級(jí)ON020300小學(xué)三年級(jí)ON020400小學(xué)四年級(jí)ON020500小學(xué)五年級(jí)ON020600小學(xué)六年級(jí)ON03初中ON030100初中一年級(jí)(七年級(jí))ON030200初中二年級(jí)(八年級(jí))ON030300初中三年級(jí)(九年級(jí))ON04高中ON040100高中一年級(jí)ON040200高中二年級(jí)ON040300高中三年級(jí)ON05中等職業(yè)教育ON05100中等職業(yè)教育一年級(jí)ON05200中等職業(yè)教育二年級(jí)ON05300中等職業(yè)教育三年級(jí)ON09其他年級(jí)77學(xué)科分類代碼學(xué)科分類代碼按照GB/T28825—2012中學(xué)科分類代碼,如表7所示。表7學(xué)科分類代碼代碼名稱備注SB基礎(chǔ)學(xué)科SB01語言與文字SB0101語文SB0102英語SB0103俄語SB0104日語SB0105德語SB0106法語SB0107其他外語SB0108中國少數(shù)民族語文SB0201數(shù)學(xué)SB03人文與社會(huì)科學(xué)SB0301政治SB0302思想品德SB0303品德與生活SB0304品德與社會(huì)SB0305社會(huì)SB0306歷史與社會(huì)SB0307歷史SB0308地理SB04自然科學(xué)SB0401物理SB0402化學(xué)SB0403生物SB0404科學(xué)SB05技術(shù)SB0501勞動(dòng)與技術(shù)教育SB0502信息技術(shù)SB0503職業(yè)教育SB0504通用技術(shù)88表7學(xué)科分類代碼(續(xù))代碼名稱備注SB0601藝術(shù)SB0602音樂SB0603美術(shù)SB0701體育SB0702體育與健康SB08綜合實(shí)踐活動(dòng)SB0801綜合實(shí)踐活動(dòng)SB0802研究性學(xué)習(xí)SB0803社區(qū)服務(wù)與社會(huì)實(shí)踐SB09跨區(qū)域的學(xué)習(xí)活動(dòng)SB10人工智能SB11勞動(dòng)實(shí)踐SB99其他課程資源類型分類代碼如表8所示。表8資源類型分類代碼9資源類型分類代碼如表8所示。表8資源類型分類代碼9代碼資源類型子類型RT01教學(xué)素材—RT02網(wǎng)絡(luò)課程—RT0201—微課RT0202—慕課RT0203—網(wǎng)校課程RT03虛擬仿真系統(tǒng)—RT04教育游戲—RT05教學(xué)案例—RT0501—教學(xué)設(shè)計(jì)RT0502—課堂實(shí)錄RT0503—教學(xué)課件RT0504—導(dǎo)學(xué)RT0599—其他RT06數(shù)字圖書—RT07數(shù)字教材—RT08教學(xué)工具—表8資源類型分類代碼(續(xù))代碼資源類型子類型RT09學(xué)習(xí)網(wǎng)站—RT10習(xí)題—RT1001—練習(xí)RT1002—章節(jié)測試RT1003—期中期末考試RT1004—中高考RT11課標(biāo)解讀—RT12教材教法分析—RT13實(shí)驗(yàn)—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動(dòng)畫F401SWF(ShockWaveFlash)F402GIF(GraphicsInterchangeFormat)F403MKVF499其他動(dòng)畫格式F9其他格式4.2.9關(guān)聯(lián)類型分類代碼4.2.9關(guān)聯(lián)類型分類代碼關(guān)聯(lián)類型分類代碼如表10所示。12表10關(guān)聯(lián)類型分類代碼代碼類型內(nèi)容示例RS01部分/全部關(guān)聯(lián)一種資源是另一種資源的物理或邏輯的一部分IsPartOf組成部分HasPart部分為RS02版本關(guān)聯(lián)一種資源是一個(gè)歷史的敘述或同一創(chuàng)建者的另一資源的版本IsVersionOf版本繼承HasVersion版本關(guān)聯(lián)RS03格式轉(zhuǎn)換關(guān)聯(lián)它不是一種解釋而是一種再現(xiàn)IsFormatOf格式轉(zhuǎn)換于HasFormat格式轉(zhuǎn)換為RS04參照關(guān)聯(lián)某一資源的作者認(rèn)可、引用、爭論或提及另一種資源IsReferencedBy被參考References參考RS05創(chuàng)造性關(guān)聯(lián)釋IsReplacedBy被替代Replaces替代RS06附屬關(guān)聯(lián)一種資源需要另一種資源產(chǎn)生效用,并表達(dá)或反映內(nèi)容IsRequiredBy被需求Requires需求Conformanceto遵循數(shù)據(jù)接口要求所有接口統(tǒng)一按照HTTPPOST方式傳遞JSON每一次數(shù)據(jù)請(qǐng)求為獨(dú)立請(qǐng)求,前后兩次請(qǐng)求之間沒有關(guān)聯(lián)。所有接口統(tǒng)一按照HTTPPOST方式傳遞JSON每一次數(shù)據(jù)請(qǐng)求為獨(dú)立請(qǐng)求,前后兩次請(qǐng)求之間沒有關(guān)聯(lián)。接口協(xié)議RESTHTTPGETPOSTGETURL(QueryParam)提供。POSTURL(QueryParam)JSON公共參數(shù)接口的請(qǐng)求和返回均包含規(guī)定的公共參數(shù),如無特殊說明,所有接口方法都應(yīng)包含以下請(qǐng)求公共參數(shù)以及返回公共參數(shù)。11表11請(qǐng)求公共參數(shù)13參數(shù)名必選數(shù)據(jù)類型長度備注access_token是String500訪問令牌,成功調(diào)用login接口后返回sign否String500請(qǐng)求參數(shù)簽名值(預(yù)留)sign_method否String500簽名方法(預(yù)留)5.3.45.3.41314表13錯(cuò)誤信息結(jié)構(gòu)14表11請(qǐng)求公共參數(shù)(續(xù))參數(shù)名必選數(shù)據(jù)類型長度備注timestamp否Date100應(yīng)用程序發(fā)出請(qǐng)求的客戶端時(shí)間,大平臺(tái)在接收到請(qǐng)求后,與當(dāng)前服務(wù)端時(shí)間比較,如果在誤差范圍大于10min,將請(qǐng)求視為無效request_id否String100應(yīng)用程序發(fā)出請(qǐng)求的唯一標(biāo)識(shí)號(hào),大平臺(tái)如果在誤差時(shí)間內(nèi)request_id外,其它請(qǐng)求將視為重放攻擊而被忽略5.3.312表12返回公共參數(shù)參數(shù)名必選數(shù)據(jù)類型長度備注ack_code是String10接口調(diào)用是否成功:SUCCESS:成功FAILURE:失敗errors否List<Error>500錯(cuò)誤信息sign否String500請(qǐng)求參數(shù)簽名值(預(yù)留)sign_method否String500簽名方法(預(yù)留)timestamp否Date100接口響應(yīng)的服務(wù)端時(shí)間correlation_id否String100request_idrequest_id在響應(yīng)時(shí)會(huì)原樣返回response_id否String100接口返回的唯一標(biāo)識(shí)號(hào)屬性必選數(shù)據(jù)類型長度備注code是String10錯(cuò)誤代碼message是String4000錯(cuò)誤信息描述inner_code否String50內(nèi)部代碼表14錯(cuò)誤代碼說明錯(cuò)誤代碼錯(cuò)誤說明原因分析處理方式11001缺少access_token參數(shù)檢查程序是否正確提供了access_token參數(shù)所有接口方法(除login外)應(yīng)提供有效的access_token11002缺少app_key參數(shù)檢查程序是否正確提供了app_key參數(shù)錯(cuò)誤需檢查接口通訊情況11003缺少sign參數(shù)提供了sign_method參數(shù),但沒有提供sign參數(shù)sign_method或者提供sign參數(shù)11004缺少sign_method參數(shù)提供了sign參數(shù),但沒有提供sign_method參數(shù)建議去掉sign參數(shù)采用不簽名方式,或者提供sign_method參數(shù)11005缺少timestamp參數(shù)提供了request_id參數(shù)但沒有提供timestamp參數(shù)建議去掉request_id參數(shù)或者提供timestamp參數(shù)11100~11199缺少第xx個(gè)應(yīng)用參數(shù)參考接口說明,按規(guī)定提供必須的參數(shù)101011數(shù)(公共輸入?yún)?shù)不計(jì)算在內(nèi))12001access_token無效產(chǎn)生此錯(cuò)誤的原因是會(huì)話尚未得到授權(quán)或者已經(jīng)超時(shí)或者已被注銷建議重新調(diào)用login方法創(chuàng)建一個(gè)新的授權(quán)會(huì)話12002app_key無效表示當(dāng)前程序不是合法的應(yīng)用程序建議申請(qǐng)獲得一個(gè)有效的app_key12003簽名校驗(yàn)失敗檢查簽名方法是否正確,并測試在發(fā)送請(qǐng)求前自行進(jìn)行簽名驗(yàn)證如果檢查無誤仍然有此錯(cuò)誤,有可能請(qǐng)求在發(fā)送過程中被篡改12004不支持的簽名方法參數(shù)配置錯(cuò)誤改用接口支持的簽名方法12005請(qǐng)求時(shí)間超過誤差范圍互聯(lián)雙方互聯(lián)通信超時(shí)問題運(yùn)行應(yīng)用程序的客戶端時(shí)間與接口服務(wù)端10min間;運(yùn)行應(yīng)用程序的客戶端與接口服務(wù)端之間中捕獲此錯(cuò)誤并重新調(diào)用。12006收到重復(fù)的請(qǐng)求參數(shù)配置錯(cuò)誤因?yàn)槌绦蝈e(cuò)誤導(dǎo)致在多次調(diào)用中產(chǎn)生了相request_id;由于網(wǎng)絡(luò)原因請(qǐng)求被偶然重發(fā),建議排查網(wǎng)絡(luò)問題或直接略忽;請(qǐng)求被記錄并重放,建議排查網(wǎng)絡(luò)安全問題。12100~12199第xx個(gè)應(yīng)用參數(shù)不合法如出現(xiàn)錯(cuò)誤代碼,例如類型不匹配請(qǐng)按照接口說明傳入正確的參數(shù)值13001第三方應(yīng)用程序未獲得授權(quán)調(diào)用指定方法表示所提供的app_key是有效的,但未獲得授權(quán)調(diào)用指定的接口方法如確實(shí)需要調(diào)用此方法,請(qǐng)向平臺(tái)管理員申請(qǐng)授權(quán)1515表14錯(cuò)誤代碼說明(續(xù))錯(cuò)誤代碼錯(cuò)誤說明原因分析處理方式13002會(huì)話未獲得授權(quán)調(diào)用指定方法當(dāng)前會(huì)話上下文無權(quán)限執(zhí)行相應(yīng)的操作例如以部分管理員身份創(chuàng)建的會(huì)話中,無權(quán)新建一個(gè)部門,建議檢查是否使用了正確的用戶身份創(chuàng)建會(huì)話13003所操作的對(duì)象超出當(dāng)前會(huì)話的可管理范圍參數(shù)配置錯(cuò)誤例如以A部門管理員身份創(chuàng)建的會(huì)話中,執(zhí)行對(duì)B部門下的事項(xiàng)操作,將返回此錯(cuò)誤,建議檢查是否使用了正確的用戶身份創(chuàng)建會(huì)話14101調(diào)用getXXX方法時(shí)找不到相應(yīng)對(duì)象參數(shù)配置錯(cuò)誤可能用來判斷是否存在此對(duì)象,建議調(diào)用getXXX空對(duì)象進(jìn)行操作14110~14199調(diào)用getXXX方法時(shí)遇到的其它錯(cuò)誤參數(shù)配置錯(cuò)誤參照具體接口方法的說明14210~14299調(diào)用listXXX方法時(shí)遇到的錯(cuò)誤參數(shù)配置錯(cuò)誤參照具體接口方法的說明14301創(chuàng)建對(duì)象時(shí)主鍵或具有唯一性的屬性重復(fù)參數(shù)配置錯(cuò)誤檢查待創(chuàng)建對(duì)象的主鍵(對(duì)象代碼)或具有唯一性的屬性是否符合規(guī)范14302創(chuàng)建對(duì)象時(shí)不允許空屬性沒有賦值參數(shù)配置錯(cuò)誤檢查待創(chuàng)建對(duì)象中不允許空的屬性14303創(chuàng)建對(duì)象時(shí)部分屬性不符合規(guī)范參數(shù)配置錯(cuò)誤例如格式不正確,超出值域等14310~14399創(chuàng)建對(duì)象時(shí)遇到的其它錯(cuò)誤參數(shù)配置錯(cuò)誤參照具體接口方法的說明14401更新對(duì)象時(shí)主鍵或具有唯一性的屬性重復(fù)參數(shù)配置錯(cuò)誤檢查待更新對(duì)象的主鍵(對(duì)象代碼)或具有唯一性的屬性是否符合規(guī)范14402更新對(duì)象時(shí)不允許空屬性沒有賦值參數(shù)配置錯(cuò)誤檢查待更新對(duì)象中不允許空的屬性14403更新對(duì)象時(shí)部分屬性不符合規(guī)范參數(shù)配置錯(cuò)誤例如格式不正確,超出值域等14410~14499更新對(duì)象時(shí)遇到的其它錯(cuò)誤參數(shù)配置錯(cuò)誤參照具體接口方法的說明14501要?jiǎng)h除的對(duì)象不存在參數(shù)配置錯(cuò)誤建議在刪除對(duì)象之前先調(diào)用getlist確認(rèn)對(duì)象存在14502子對(duì)象不為空,無法刪除主對(duì)象參數(shù)配置錯(cuò)誤除接口有特殊說明外,在刪除對(duì)象前應(yīng)先刪除所有子對(duì)象14503待刪除的對(duì)象存在引用,不能刪除在刪除對(duì)象時(shí),應(yīng)先移除所有對(duì)該對(duì)象的引用關(guān)系例如在刪除一個(gè)服務(wù)窗口前,應(yīng)保證所有引用該窗口的事項(xiàng)中移除相應(yīng)的引用關(guān)系14510~14599在刪除對(duì)象時(shí)遇到的其它錯(cuò)誤參數(shù)配置錯(cuò)誤參照具體接口方法的說明1616表14錯(cuò)誤代碼說明(續(xù))錯(cuò)誤代碼錯(cuò)誤說明原因分析處理方式建議應(yīng)用程序間隔一段時(shí)間后再自動(dòng)嘗試重19000~19999示接口服務(wù)端或客戶端程序出現(xiàn)不可預(yù)測的內(nèi)結(jié)果。偶然出現(xiàn)此類錯(cuò)誤復(fù)后的通知,再協(xié)助進(jìn)行后續(xù)的處理。5.3.5SignppKey、timestamp、randomNum、appSecresha115表15額外參數(shù)屬性必選數(shù)據(jù)類型長度備注appSecret是string500APP應(yīng)用密鑰,由網(wǎng)關(guān)方提供(自行保存,不可泄露)字符串順序規(guī)則字符串順序規(guī)則字符串順序規(guī)則:appSecret+randomNum+appKey+timestamp+appSecret。sha1Java)sha1加密代碼實(shí)現(xiàn)(Java)見附錄A。接口調(diào)用過程loginaccess_token調(diào)用安全會(huì)話接口的login方法,以部門管理員賬戶創(chuàng)建會(huì)話獲取訪問令牌access_token,請(qǐng)求示例見附錄B中B.1.1。access_tokenAPI把a(bǔ)ccess_token作為請(qǐng)求的公共參數(shù)來調(diào)用接口API,示例見附錄B中B.1.2。logout調(diào)用安全會(huì)話接口的logout方法,設(shè)置access_token為無效,示例見附錄B中B.1.3。5.5對(duì)象模型17UserInfo(用戶信息類16表16UserInfo(用戶信息類)屬性必選長度類型備注account是100String賬戶名稱,標(biāo)識(shí)屬性name是100String用戶姓名identity_num否20String身份證件號(hào)碼division是256String行政區(qū)劃名稱,只讀屬性division_code是20String行政區(qū)劃代碼,只讀屬性service_org是256ServiceOrg所屬機(jī)構(gòu),只讀屬性extend_props否4000String擴(kuò)展屬性creator否100String創(chuàng)建者creation_time是100Date創(chuàng)建時(shí)間last_modificator否100String最后修改者last_modification_time是100Date最后修改時(shí)間ResourceInfo(資源信息類17表17ResourceInfo(資源信息類)屬性必選長度類型備注title是1000變長類型標(biāo)題language_code是20變長類型語種alternativetitle否1000變長類型其他標(biāo)題description否2000變長類型描述keyword否1000變長類型關(guān)鍵字version是50變長類型版本learning_mode否100變長類型學(xué)習(xí)方式audience是200變長類型用戶類型curricular_tandard是1000變長類型課程標(biāo)準(zhǔn)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變長類型課程內(nèi)容分類代碼vediopoint否100時(shí)間類型視頻節(jié)點(diǎn)voicepoint否100時(shí)間類型語音節(jié)點(diǎn)interval_code是100變長類型學(xué)段代碼grade_level_code是100變長類型年級(jí)代碼curricular_code是100變長類型學(xué)科代碼version是100變長類型版本volume是100變長類型冊(cè)數(shù)unit是300變長類型單元chapter是300變長類型章part是100變長類型節(jié)createdtime是100時(shí)間類型創(chuàng)建時(shí)間downloadsum否100整數(shù)值型下載總數(shù)clicksum否100整數(shù)值型點(diǎn)擊總數(shù)collectsum否100整數(shù)值型收藏總數(shù)learning_resource_type_Code是100變長類型資源類型format_Code是100變長類型資源格式size是30數(shù)值型資源大小publisher否100變長類型出版社authoretc否300變長類型其他作者abstract是2000變長類型摘要2D否100變長類型二維碼描述address否300變長類型存儲(chǔ)地址relationship_code否8變長類型關(guān)聯(lián)類型代碼Relationship_de否300變長類型關(guān)聯(lián)類型描述APIsecurity/login.do方法名稱:login。方法說明:通過用戶名和密碼進(jìn)行身份驗(yàn)證,驗(yàn)證成功后創(chuàng)建一個(gè)會(huì)話。所有對(duì)數(shù)據(jù)和附件的管理操作都應(yīng)在有效的會(huì)話內(nèi)進(jìn)行。請(qǐng)求方法:POST。URLhttp://{API_ROOT}/security/login.do。訪問權(quán)限:所有通過授權(quán)的第三方程序。1819請(qǐng)求示例見附錄B中B.2.1。返回示例見附錄B中B.2.2。請(qǐng)求示例見附錄B中B.2.1。返回示例見附錄B中B.2.2。security/logout.do方法名稱:logout。方法說明:注銷當(dāng)前會(huì)話。請(qǐng)求方法:POST。URLhttp://{API_ROOT}/security/logout.do。訪問權(quán)限:所有已登錄用戶。請(qǐng)求參數(shù):無。返回結(jié)果:無。BB.2.3。BB.2.4。security/get_current_user.do方法名稱:get_current_user。方法說明:獲取當(dāng)前已登錄用戶的信息。請(qǐng)求方法:GET。URL地址:http://{API_ROOT}/security/get_current_user。訪問權(quán)限:所有已登錄用戶。請(qǐng)求參數(shù):無。2020表18請(qǐng)求參數(shù)參數(shù)名必選數(shù)據(jù)類型長度備注app_key是String500分配給應(yīng)用程序的app_keyapp_secret是String500分配給應(yīng)用程序的app_secretaccount是String500用戶賬戶名稱password是String500用戶賬戶密碼org_code否String500以指定的部門管理員身份登錄19表19返回結(jié)果參數(shù)名必選數(shù)據(jù)類型長度備注access_token是String500登錄成功則返回安全會(huì)話訪問令牌expires_in是Integer500訪問令牌超時(shí)時(shí)間(以秒為單位),缺省24hsuccess否String500登錄標(biāo)識(shí)msg否String500登錄成功信息attributes是Map<String,Object>500返回的數(shù)據(jù)22表22返回結(jié)果BB.2.7。BB.2.8。21表20返回結(jié)果參數(shù)名必選數(shù)據(jù)類型長度備注attributes是TSUser500用戶信息success否String500登錄標(biāo)識(shí)msg否String500登錄成功信息請(qǐng)求示例見附錄B中B.2.5。返回示例見附錄B中B.2.6。data_subject/list.do方法名稱:list。方法說明:根據(jù)設(shè)置條件(支持標(biāo)題、作者、用戶類型等)查詢數(shù)據(jù)主題信息。如:查詢標(biāo)題包含“三角形”資源。請(qǐng)求方法:POST。URLhttp://{API_ROOT}/data_subject/list。訪問權(quán)限:所有已登錄用戶。21表21請(qǐng)求參數(shù)參數(shù)名必選數(shù)據(jù)類型長度備注title否String1000標(biāo)題author否String100作者audience否String200用戶類型參數(shù)名必選數(shù)據(jù)類型長度備注total_count否Integer100記錄數(shù)data否List<DataSubjectInfo>50資源詳細(xì)描述信息附錄A(資料性)sha1加密代碼實(shí)現(xiàn)(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(資料性)接口調(diào)用過程示例下面給出了調(diào)用login創(chuàng)建安全會(huì)話登錄獲取access_token的示例。POSThttp://{API_ROOT}/security/login.doContent-Type:application/json{"app_key":"APP_KEY","app_secret":"APP_SECRET","account":"ACCOUNT","password":"PASSWORD"}返回結(jié)果:POSThttp://{API_ROOT}/security/login.doContent-Type:application/json{"app_key":"APP_KEY","app_secret":"APP_SECRET","account":"ACCOUNT","password":"PASSWORD"}返回結(jié)果:{"success":true,"msg":"登陸成功!","obj":null,"attributes":{"access_token":"4028098184325ff2018432a1f22c0002","expires_in":86400}}下面給出了使用access_token調(diào)用接口API的示例。GET http://{API_ROOT}/security/get_current_user.do?access_token=ACCESS_TOKEN返回結(jié)果:{GET http://{API_ROOT}/security/get_current_user.do?access_token=ACCESS_TOKEN返回結(jié)果:{"ack_code":"SUCCESS","msg":"獲取當(dāng)前用戶成功","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{}下面給出了調(diào)用logout注銷會(huì)話的示例。POSThttp://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKENContent-Type:application/json返回結(jié)果:POSThttp://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKENContent-Type:

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論