第三方系统资源元数据信息同步协议

国家教育资源智能导航系统第三方系统资源信息接入协议科大讯飞信息科技股份有限公司2014年05月版本记录版本号时间记录人变更原因变更描述VI2014/6/13李斌松初步完成1.文档目的教育资源集中展示系统搜索和导航需要第三方教育资源系统的资源元数据，例如国家教育资源公共服务平台、安徽教育云平台、学科网等资源系统。为了实现汇集的第三方资源信息能在集中展示系统中可被导航，需要保证第三方资源目录属性符合集中展示系统要求。同时，为了保证汇集资源的搜索效果，也需要第三方资源信息包含必要的扩展属性。为此，本文档定义了元数据描述标准。在统一的元数据标准下，集中展示系统提供多种灵活的资源信息交换方式与第三方资源系统进行信息汇总与同步。只要第三方资源系统满足信息交换接口，就可以将资源信息同步到集中展示平台。元数据标准描述元数据描述标准包含了资源元数据字段定义、资源类型定义及相关定义的样例。详细内容参见《资源元数据标准描述》，相关枚举类型字段值，请参见《资源字段枚举值.X1SX》。资源信息交换接口第三方系统同步资源元数据到教育资源集中展示系统之前，需要标准化《资源元数据字段定义》中定义的枚举类型字段值，各个枚举类型字段值，请参考《资源字段枚举值X1SX》文档。根据第三方系统的实际情况，系统提供两种数据同步接口：3.1SFTP接口第三方系统把自己已有资源元数据信息按照《资源元数据标准描述》导出写入到txt文件中，再通过SFTP方式上传到教育资源集中展示系统提供的FTPServer。教育资源集中展示系统定时扫描FTPServer目录，检查是否有txt文件，如果发现新txt文件，解析txt文件中资源元数据信息入库。并把解析过的txt文件转移到其他文件夹中备份。数据同步支持全量和增量同步方式，第三方系统首次同步数据使用全量同步资源元数据以后定期增量同步资源元数据数据。资源同步交互时序图如下图所示：第三方系统■教育资源集中展示系统■搜索引擎I1•洛湄坛淮存FTP数据交互时序图）3.1.1数据格式第三方系统同步资源元数据到教育资源集中展示系统之前，需要标准化资源元数据，标准化的字段有：资源类型、知识点、年级、学科、课本、单元、课、出版社、资源来源、资源扩展名，标准化字段信息请参考附件《资源元数据标准描述》。Txt同步文件数据格式定义如下：第三方接入资源系统每次导出的所有资源元数据写入同一个txt文件中。txt文件包含多条资源元数据，每条完整资源元数据使用特殊字符串区分开始和结束。资源开始字符串：s==========s\r\n资源结束字符串：e==========e\r\n一条完整资源元数据包含多个字段，每一行包含一个字段信息，格式为：字段名称=字段值內，等号（=）前后各有一个空格。资源元数据所有字段名称请参考4.1资源元数据字段定义》

文件中换行符为：\r\n。资源信息增加、更新、删除使用status字段值标识，新增0，更新1，删除-16.完整资源元数据格式如下：™vendorResId":"ff80808141650644014167celfc7000211rrenamer,:TFqqeT20130719143950™P■":Langu&g皂™rtypel":™ZY001rBrrtype釘："J^SDurce^z^OOl^r"publishDate":™2000-07-0100:00:00™,wpmodeln,:™01,P"price":™™,IBsuitableUser":™jcjffxlx1":11JCJFFKO00"rreutime":™2013-09-2911:41:03™,FuounfCTj,■™url™:"htx口：/F1.a;1k.已dLuyun・匚n/口口ftaZLf1日].k7日口□:r匸日1/wi已时_on已已日，”耳日口？e已日I:!=庄至g;0总138].4丄55口£44014]_石'7匚己1:£匚700wdesc":T'rarPut;hc0:「"tags11:'1™,吒iWEjctensiDn":"jpg"r"contentType ."commentcDunt11二『"commentscore":r"™r"speaker™:™11PIBspeakerDesr,:T,r'P"courseStiandiardr':w"r吒humbUEl"严『IBgria.de,1!:w，rar"phase":"",™techlype™:r'fflP"publi曰h"%r”："J"bDDlr":,,,Fr"subject,F:chapter1':具体实例，请参考附件：resource_anhui_20140620.txt具体实例，请参考附件：3.1.2文件名格式Txt文件名格式分为增量和全量两种格式，如下：＞增量文件格式：resource.第三方系统编码_时间.txt，其中时间为资源元数据同步时间,时间格式为yyyymmdd。＞全量文件格式：resource.第三方系统编码_all.txt例如安徽资源云平台同步数据给教育资源集中展示系统文件名格式：resource_anhui_20140522.txt或resource_anhui_all.txt。

3.2Restful接口第三方系统调用教育资源集中展示系统开放RestfulAPI接口，实时增量同步资源元数据,第三方系统同步数据之前，需要通过用户名和密码获取oauth2服务请求token。服务调用过程如下图：—1：茯取oanthtoken ——2—1：茯取oanthtoken ——2:返回accesstoken--3：资源更新调用服务接口4:资源索引更新--5：操作返回--初次接入教育资源集中展示系统，资源数据量比较大，全量导入资源数据方式采用FTP接口全量导入数据。3.2.1获取oauth2服务请求token1.请求说明url/oauth7oauth/token?请求参数格式Form表单形式提交HttpmethodGet,Post是否需要授权否请求参数实例：grant_type=client_credentials&client_id=***&client_secret=****2.参数说明参数名备注grant_type授权方式，目前开放支持clientcredentialsclient_id分配的客户端授权标识clientsecret 分配的客户端授权密钥操作成功，http相应状态值为：200,返回json数据格式，得到access_token，实例数据如下：{"access_token":"e0b97df8-8b17-41bc-861f-598b5b3e1dc5","token_type":"bearer","refresh_token":"8696789f-0cc4-4890-988b-7b767160ee37","expires_in":3599,"scope":"deletereadwrite"}操作失败，根据不同失败原因，http相应状态值不同，并返回不同的错误信息。3.2.2新增资源元数据1.请求说明参数名备注url/resource/add?请求参数格式form表单提交参数形式Httpmethodpost是否需要授权是请求参数实例：appkey=****&access_token=****&data=****Data事例数据结构：[{nvendorResId,,:nff80808141650644014167celfc70002"r"name":^6120130719143950","language",nrtypel":mZY001m,"匸匸严f"source"^OOl",,,publi3hDaten:"2000-07-0100:00:00"P"pmodel^^O","price":"","suitableUser":n"r"jcjffxlx":"JCJFEX000°,"utime0:"2013-09-2911:41:03","vcounf^O",wurl":"hf口:;F/ls1k*已dluyuh*cn/口orx&l/1s1kFs口口rr&l/审i亡対_口11亡_1■亡s*Jsg?r■亡3LdL=:f丘3030314]■石百0石440141石7c亡]■丘uYCiOCiE乐m亡miFl&口=；3“,wauthor":°11,"tags":1'1',^fileExtension":"jpg","content!ype"严，"coinmentcounf,:「"commentscoren:nnr"speaker":1,0,nspeaker0e3n:wl,r"courseStandard":吒humbUE：L":「"grade""phase":"","忧uhType七",npublisherVern:n,,r"books「"subject""issbnTJ"chapter":1,11

2.参数说明参数名备注appkey必填，客户端标识appkeyaccess_tokenOauth访问tokendata资源兀JSON数据，兀数据信息请参考《6.1资源兀数据字段定义》3.返回信息操作成功，http相应状态值为：200,操作失败，根据不同失败原因，http相应状态值不同，并返回不同的错误信息。3.2.3更新资源元数据1.请求说明参数名备注url/resource/update?请求参数格式form表单提交参数形式HttpmethodPost是否需要授权是请求参数实例：appkey=****&access_token=****&data=****Data事例数据结构：wvendorRe3ld,,:fflff80808141650644014167celfc70002"rwnamere:,,qqeT20130719143950,,r"language"11,"rtypel^^ZYOOl","rtype2n:ni,r"source":"001","publishDate'":"2000-07-0100:00:00nr"price":"","suitableUser""jcjffxlx":"JCJFEXO00","utime":"2013-09-2911:41:03","vcounf^O",wurl":"h匸匕口::://11k"已dluyuh*cn/口orx&l/1s1k/出口口匸匕自丄/¥i已vr_©riE_r■已s*T？匸已s1也=丘丘302口2141石£0石440141石7匚已1丘匚7口0口2已miFI及口=3“rnd^3Cn2nnrwauthor":w11r,,tags,':nwrmfileExtension0:njpg"r"content!ype"coinmentcounf,:"commentscore":"speaker":1,0rFpe&k亡匸W严，"courseStandard":rethumbUrln:ni,F"grade""phase":"","匸亡uhType":","publisherVernznnf"bookr",nsuboect":1,wr"isbn"chapter"2.参数说明参数名备注appkey必填，客户端标识appkeyaccess_tokenOauth访问tokendata资源兀JSON数据，兀数据信息请参考《6.1资源兀数据字段定义》3.返回信息操作成功，http相应状态值为：200,不返回数据。操作失败，根据不同失败原因，http相应状态值不同，并返回不同的错误信息。接口协议对比对比两种数据同步协议，每种方式有各自的优缺点：SFTP接口：数据同步系统相互依赖关系比较小，不影响双方系统的运行，同时适合大量数据的传输交互，但数据更新不够及时。Restful服务接口：数据同步系统相互依赖关系比较强，但能实时更新资源数据接口方式实时性相互依赖程度对第二方系统影响支持大批量数据更新SFT接口一般较弱弱支持Restful接口实时强强不支持资源全文检索资源全文检索通过对资源内容的数据分析，建立以内容为依据的搜索索引库。由于全文检索是基于内容分析，所以第三方系统必需提供资源原文件,且资源文件以HTTP协议接口提供，系统通过接口获取文件后，对内容进行分析并创建全文检索索引，从而实现资源的全文检索。资源文件获取接口规范说明如下1、请求说明参数名备注url/resource/search?name=1&page=1&limit=10&appkey=YGZY&access_token=0fe0c98102334630f99646074c77204f请求参数格式Form表单形式提交HttpmethodGet,Post是否需要授权是2、参数说明参数名备注appkey必填，客户端标识appkeyaccess_token必填，客户端标识验证tokenpage必填，页码limit必填，分页大小orderfield可选，排序字段:utime、vcountsort可选，排序方式:ASC、DESC3、返回数据操作成功，http相应状态值为：200，返回资源内容字节流。操作失败，根据不同失败原因，http相应状态值不同，并返回不同的错误信息。

附件：《资源元数据标准描述》6.1资源元数据字段定义字段名说明必填值字段类型备注vendorResId第三方资源ID是文本name资源名称是文本language语种是文本间体中文：zh-CN,美语：en-USrtypel资源类型是枚举参考《资源类型》rtype2资源子类型否枚举参考《资源类型》source资源来源是枚举参考《资源来源》knowledgel一级知识点否文本knowledge2二级知识点否文本knowledge3三级知识点否文本knowledge4四级知识点否文本phase学段是枚举参考《学段枚举值》grade年级是枚举参考《年级枚举值》subject学科是文本地理信息系统学科IdpublishDate出版日期、版次否文本isbnISBN否文本publisherVer教材版本否文本使用地理信息系统教材版本Idbook教材Id否文本使用地理信息系统教材Idchapter所属单元否文本使用地理信息系统章节Id,各层级以逗号分隔如一级目录id,二级目录id,…pmodel付费模式否枚举0：免费、1：付费price价格否数字techType适用教育类型否枚举参考《适用教育枚举值》courseStandard所属课程标准否枚举参考《所属课程标准枚举值》suitableUser使用对象否枚举参考《适用学习者枚举值》

jcjffxlx教材教法分析类别否枚举参考《教材分析枚举值》utime资源上传时间是时间格式：2014-03T512:23:45vcount浏览次数否数字url资源地址是urldesc资源描述（摘要）是文本author资源作者是文本tags关键词否文本多个关键词使用半角逗号分隔speaker主讲人否文本speakerDes主讲人介绍否文本thumbUrl缩略图地址否urlcontentType文件格式否枚举参考《文件格式枚举值》fileExtension文件扩展名是文本commentcount评论次数否数字commentscore评分否文本status资源删除或新增状态是枚举新增0、更新1、删除-16.2资源类型资源类型 资源子类型 CODE教学设计ZY001教学课件ZY002课堂实录ZY003素材ZY004微课ZY005习题ZY006练习ZY006001章节测试ZY006002期中期末考试ZY006003工具ZY007学科工具ZY007001常用工具ZY007002仿真实验室ZY007003数字教材ZY008实验ZY009演示实验ZY009001学生实验ZY009002仿真实验ZY009003课标解读ZY010教材教法分析ZY011其它ZY000学段枚举值学段CODE小学XDOO1初中XD002咼中XD003中职XD004高职XD005学刖教育XD006年级枚举值年级CODE学刖教育NJOO1一年级NJ002二年级NJ003三年级NJ004四年级NJ005

五年级NJ006六年级NJ007七年级NJ008八年级NJ009九年级NJ010高一NJ011高二NJ012咼二NJ013适用学习者枚举值适用教育类型CODE学刖教育SYLXOO1小学SYLX002初中SYLX003咼中SYLX004中等职业教育SYLX005高等职业教育SYLX006高等教育SYLX007成人与继续教育SYLX008家庭教育SYLX009社会教育SYLX010其它SYLX011普通中等教育SYLX012不分类型的全体SYLX013所属课程标准枚举值所属课程标准CODE2001课程标准KCBZOO12011课程标准KCBZ002

6.7文件格式枚举值分类文件格式CODE文本GS001txtGSOO1OO1htmlGS001002plainGS001003sgmlGS001004xmlGS001