DB4401T+223-2023教育电子学习资源数据接口规范_第1页
DB4401T+223-2023教育电子学习资源数据接口规范_第2页
DB4401T+223-2023教育电子学习资源数据接口规范_第3页
DB4401T+223-2023教育电子学习资源数据接口规范_第4页
DB4401T+223-2023教育电子学习资源数据接口规范_第5页
已阅读5页,还剩30页未读 继续免费阅读

下载本文档

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

文档简介

DB4401ICS35.240.01DB4401CCSL67广 州 市 地 方 标 准DB4401/T223—2023教育电子学习资源数据接口规范Specificationofdatainterfaceforeducationale-learningresources2023-2023-080520230905广州市市场监督管理局发布DB4401/T223—2023目 次前言 III引言 V范围 1规范性引用文件 1术语和定义 1接口数据模型及数据分类代码 1接口数据模型 1数据分类代码 5数据接口要求 13接口访问流程 13接口协议 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部分:标准化文件的结构和起草规则》的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由广州市教育局提出并归口。本文件起草单位:广州市电化教育馆、广州市标准化研究院、广州市越秀区市场监督管理局。本文件主要起草人:钟毅、孙立杰、彭斌、霍迎辉、郑勇、罗杰明、肖劲峰。IIIIIIDB4401/TXXXXX—2023IVDB4401/TXXXXX—2023IVDB4401/T223—2023DB4401/T223—2023引 言VVDB4401/T223—2023DB4401/T223—2023DB4401/T223—2023DB4401/T223—2023教育电子学习资源数据接口规范范围本文件规定了教育电子学习资源数据接口的数据模型、数据分类代码和数据接口要求。规范性引用文件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多语言字符串以文本方式对资源内容的简介“通过基础知识识。”420005关键字,keyword多语言字符串1000用以描述资源主要内容的关键词语“气密性”6版本,version多语言字符串50该资源所属学科课文版本“Demo”“公开测试版”学习方式,learningmode多语言字符串该资源所适用的学习行为,体现学生在自主性、探究性和合作性方面的基本特征71008用户类型,audience字符串200该资源的主要使用者,最重要的优先列出“学龄前儿童”9课程标准,curricularstandard字符串1000描述该资源与国家课程标准内容框架的对应关系10教材目录,textbookcode字符串1000描述该资源与教材内容框架对应关系11专题教育资源代码,specialsubject_code字符串100在实施教育教学的过程中,专门研究或讨论的题目22表1接口数据模型(续)序号数据名称数据类型数据长度(字符)备注示例12来源,source字符串1000该资源引用的访问互联网地址“/”13作者,author多语言字符串100发布该资源的作者姓名记录14主讲人,instructor多语言字符串100该资源中的主讲人的姓名记录15作者所在单位,authorc多语言字符串100该资源创建者的所在单位名字记录16作者所在单位代码,authorc_code字符串100该资源创建者的所在单位名字代码,使用广州市中小学的学校代码(广州市中小学学籍数据库中各个单位唯一代码)17作者所在区域或县代码,author_Area_code多语言字符串100该资源作者所在区域或县代码18作者所在省份代码,authorp_code多语言字符串100该资源作者所在省份代码19作者所在城市代码,authorcity_code多语言字符串100该资源作者所在城市代码20课程内容分类代码,knowledge_code多语言字符串300该资源所属知识点标识代码,根据JY/T0607—2017选取21视频节点,vediopoint字符串100视频资源节点时间戳22语音节点,voicepoint字符串100语音资源节点时间戳23学段代码,interval_code字符串100该资源所属学段24年级代码,grade_level_code字符串100该资源所属年级代码25学科代码,curricular_code字符串100该资源所属学科代码33表1接口数据模型(续)序号数据名称数据类型数据长度(字符)备注示例26版本,version多语言字符串100该资源所属学科课文版本27册数,volume多语言字符串100该资源所属学科课文册28单元,unit多语言字符串300该资源所属学科课文单元名称29章,chapter多语言字符串300该资源所属学科课文章名称30节,part多语言字符串300该资源所属学科课章节名称31创建时间,createdtime日期时间按GB/T7408—2005相关要求该资源创建时间“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接口数据模型(续)序号数据名称数据类型数据长度(字符)备注示例42存储地址,address多语言字符串300该资源存储的计算机网络访问地址“http:///1.ppt”43资源分类代码,Resourceclassificationcode字符串100该资源属于的分类描述44关联类型代码,relationship_code字符串8描述该资源与关联资源之间的关系45关联描述,relationship_description字符串300关联资源的描述数据分类代码语种分类代码从《中国图书馆图书分类法(第五版)》和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行为养成教育SS04安全教育SS05心理健康教育SS06国防教育SS07体育与健康教育SS08民族团结教育SS09艺术教育SS10科普教育表5专题教育分类代码(续)代码类型备注SS11家庭教育SS12学校管理SS13劳动教育SS14地方教育SS15德育教育SS99其他教育年级分类代码按照GB/T28825—2012中适用对象分类代码,如表6所示。表6年级分类代码代码名称备注ON正规教育ON01学前ON0101000~2岁ON0102003~6岁ON02小学ON020100小学一年级ON020200小学二年级ON020300小学三年级ON020400小学四年级ON020500小学五年级ON020600小学六年级ON03初中ON030100初中一年级(七年级)ON030200初中二年级(八年级)ON030300初中三年级(九年级)ON04高中ON040100高中一年级ON040200高中二年级ON040300高中三年级ON05中等职业教育ON05100中等职业教育一年级ON05200中等职业教育二年级ON05300中等职业教育三年级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职业教育SB0504通用技术88表7学科分类代码(续)代码名称备注SB0601艺术SB0602音乐SB0603美术SB0701体育SB0702体育与健康SB08综合实践活动SB0801综合实践活动SB0802研究性学习SB0803社区服务与社会实践SB09跨区域的学习活动SB10人工智能SB11劳动实践SB99其他课程资源类型分类代码如表8所示。表8资源类型分类代码9资源类型分类代码如表8所示。表8资源类型分类代码9代码资源类型子类型RT01教学素材—RT02网络课程—RT0201—微课RT0202—慕课RT0203—网校课程RT03虚拟仿真系统—RT04教育游戏—RT05教学案例—RT0501—教学设计RT0502—课堂实录RT0503—教学课件RT0504—导学RT0599—其他RT06数字图书—RT07数字教材—RT08教学工具—表8资源类型分类代码(续)代码资源类型子类型RT09学习网站—RT10习题—RT1001—练习RT1002—章节测试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格式分类代码(续)代码名称备注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格式分类代码(续)代码名称备注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关联类型分类代码4.2.9关联类型分类代码关联类型分类代码如表10所示。12表10关联类型分类代码代码类型内容示例RS01部分/全部关联一种资源是另一种资源的物理或逻辑的一部分IsPartOf组成部分HasPart部分为RS02版本关联一种资源是一个历史的叙述或同一创建者的另一资源的版本IsVersionOf版本继承HasVersion版本关联RS03格式转换关联它不是一种解释而是一种再现IsFormatOf格式转换于HasFormat格式转换为RS04参照关联某一资源的作者认可、引用、争论或提及另一种资源IsReferencedBy被参考References参考RS05创造性关联释IsReplacedBy被替代Replaces替代RS06附属关联一种资源需要另一种资源产生效用,并表达或反映内容IsRequiredBy被需求Requires需求Conformanceto遵循数据接口要求所有接口统一按照HTTPPOST方式传递JSON每一次数据请求为独立请求,前后两次请求之间没有关联。所有接口统一按照HTTPPOST方式传递JSON每一次数据请求为独立请求,前后两次请求之间没有关联。接口协议RESTHTTPGETPOSTGETURL(QueryParam)提供。POSTURL(QueryParam)JSON公共参数接口的请求和返回均包含规定的公共参数,如无特殊说明,所有接口方法都应包含以下请求公共参数以及返回公共参数。11表11请求公共参数13参数名必选数据类型长度备注access_token是String500访问令牌,成功调用login接口后返回sign否String500请求参数签名值(预留)sign_method否String500签名方法(预留)5.3.45.3.41314表13错误信息结构14表11请求公共参数(续)参数名必选数据类型长度备注timestamp否Date100应用程序发出请求的客户端时间,大平台在接收到请求后,与当前服务端时间比较,如果在误差范围大于10min,将请求视为无效request_id否String100应用程序发出请求的唯一标识号,大平台如果在误差时间内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个应用参数参考接口说明,按规定提供必须的参数101011数(公共输入参数不计算在内)12001access_token无效产生此错误的原因是会话尚未得到授权或者已经超时或者已被注销建议重新调用login方法创建一个新的授权会话12002app_key无效表示当前程序不是合法的应用程序建议申请获得一个有效的app_key12003签名校验失败检查签名方法是否正确,并测试在发送请求前自行进行签名验证如果检查无误仍然有此错误,有可能请求在发送过程中被篡改12004不支持的签名方法参数配置错误改用接口支持的签名方法12005请求时间超过误差范围互联双方互联通信超时问题运行应用程序的客户端时间与接口服务端10min间;运行应用程序的客户端与接口服务端之间中捕获此错误并重新调用。12006收到重复的请求参数配置错误因为程序错误导致在多次调用中产生了相request_id;由于网络原因请求被偶然重发,建议排查网络问题或直接略忽;请求被记录并重放,建议排查网络安全问题。12100~12199第xx个应用参数不合法如出现错误代码,例如类型不匹配请按照接口说明传入正确的参数值13001第三方应用程序未获得授权调用指定方法表示所提供的app_key是有效的,但未获得授权调用指定的接口方法如确实需要调用此方法,请向平台管理员申请授权1515表14错误代码说明(续)错误代码错误说明原因分析处理方式13002会话未获得授权调用指定方法当前会话上下文无权限执行相应的操作例如以部分管理员身份创建的会话中,无权新建一个部门,建议检查是否使用了正确的用户身份创建会话13003所操作的对象超出当前会话的可管理范围参数配置错误例如以A部门管理员身份创建的会话中,执行对B部门下的事项操作,将返回此错误,建议检查是否使用了正确的用户身份创建会话14101调用getXXX方法时找不到相应对象参数配置错误可能用来判断是否存在此对象,建议调用getXXX空对象进行操作14110~14199调用getXXX方法时遇到的其它错误参数配置错误参照具体接口方法的说明14210~14299调用listXXX方法时遇到的错误参数配置错误参照具体接口方法的说明14301创建对象时主键或具有唯一性的属性重复参数配置错误检查待创建对象的主键(对象代码)或具有唯一性的属性是否符合规范14302创建对象时不允许空属性没有赋值参数配置错误检查待创建对象中不允许空的属性14303创建对象时部分属性不符合规范参数配置错误例如格式不正确,超出值域等14310~14399创建对象时遇到的其它错误参数配置错误参照具体接口方法的说明14401更新对象时主键或具有唯一性的属性重复参数配置错误检查待更新对象的主键(对象代码)或具有唯一性的属性是否符合规范14402更新对象时不允许空属性没有赋值参数配置错误检查待更新对象中不允许空的属性14403更新对象时部分属性不符合规范参数配置错误例如格式不正确,超出值域等14410~14499更新对象时遇到的其它错误参数配置错误参照具体接口方法的说明14501要删除的对象不存在参数配置错误建议在删除对象之前先调用getlist确认对象存在14502子对象不为空,无法删除主对象参数配置错误除接口有特殊说明外,在删除对象前应先删除所有子对象14503待删除的对象存在引用,不能删除在删除对象时,应先移除所有对该对象的引用关系例如在删除一个服务窗口前,应保证所有引用该窗口的事项中移除相应的引用关系14510~14599在删除对象时遇到的其它错误参数配置错误参照具体接口方法的说明1616表14错误代码说明(续)错误代码错误说明原因分析处理方式建议应用程序间隔一段时间后再自动尝试重19000~19999示接口服务端或客户端程序出现不可预测的内结果。偶然出现此类错误复后的通知,再协助进行后续的处理。5.3.5SignppKey、timestamp、randomNum、appSecresha115表15额外参数属性必选数据类型长度备注appSecret是string500APP应用密钥,由网关方提供(自行保存,不可泄露)字符串顺序规则字符串顺序规则字符串顺序规则:appSecret+randomNum+appKey+timestamp+appSecret。sha1Java)sha1加密代码实现(Java)见附录A。接口调用过程loginaccess_token调用安全会话接口的login方法,以部门管理员账户创建会话获取访问令牌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行政区划名称,只读属性division_code是20String行政区划代码,只读属性service_org是256ServiceOrg所属机构,只读属性extend_props否4000String扩展属性creator否100String创建者creation_time是100Date创建时间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变长类型作者所在区域或县代码authorp_code是100变长类型作者所在省份代码authorcity_code是100变长类型作者所在城市代码1818表17ResourceInfo(资源信息类)(续)属性必选长度类型备注knowledge_code否300变长类型课程内容分类代码vediopoint否100时间类型视频节点voicepoint否100时间类型语音节点interval_code是100变长类型学段代码grade_level_code是100变长类型年级代码curricular_code是100变长类型学科代码version是100变长类型版本volume是100变长类型册数unit是300变长类型单元chapter是300变长类型章part是100变长类型节createdtime是100时间类型创建时间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变长类型关联类型代码Relationship_de否300变长类型关联类型描述APIsecurity/login.do方法名称:login。方法说明:通过用户名和密码进行身份验证,验证成功后创建一个会话。所有对数据和附件的管理操作都应在有效的会话内进行。请求方法: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创建安全会话登录获取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":"白云区用户","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. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论