龙岩市教育公共服务平台

服务中心

>网站首页>对接文档>内容详情

龙岩市教育数据共享服务平台-资源中心接口v1

发布时间: 2022-10-12 11:13 发布单位: 龙岩市教育局云管中心 浏览量: 3302 【公开】

 

 

【龙岩市教育数据共享服务平台】

资源中心接口

(版本号 V1.0

 

 

文档修订记录

版本号

状态

简要说明

日期

变更人

V1.0

建立

资源中心接口

2022-03-02

童倩

V1.1

新增

新增接口

2022-05-10

童倩

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1       接口服务规范

1.1、接口说明

龙岩市教育数据共享服务平台在政务信息网和政务外网、互联网区提供Restful接口,各部门业务系统通过调用该Restful接口,实现政务数据实时共享

1.2、使用约束

限制类型

限制说明

传输字符编码格式

平台接口采用的是UTF-8编码格式

传输数据格式

平台接口采用JSON格式

 

1.3、接口原则

为了保证汇聚共享平台对外提供的统一接口安全可靠、简易兼容,接口规范应满足如下原则:

(1)            接口具有普遍的适应性;

(2)            使用简单、快捷的方式实现其他系统的接入;

(3)            接口应充分考虑省汇聚共享平台的应用扩展情况;

(4)            保证接口数据在省汇聚平台与用户系统的一致性;

(5)            接口调用能够方便的形成,并能在接入方顺利地实现;

(6)            在满足功能要求的前提下,使接口数据量最少;

(7)            接口数据传输控制策略可靠且完善;

(8)            具有可靠的接口数据出错返回机制。

 

2      接口使用规范

 

1.     2.1、通用规范

2.1.1协议

所有接口调用均采用HTTP远程调用方式,客户端调用并同步返回响应。数据格式: json

2.1.2 请求

1. 请求方式:get/post, 服务地址url格式为http://domain/[service]/[servicename]

其中:domain为服务域名、service为服务名称、servicename 为API名称.

2. 协议消息头包含以下属性:

Content-Type:application/json;charset=utf-8;

3. 请求header包含以下参数:

user-date: 调用日期。格式yyyyMMddHHmmssSSS。17位日期字符串,小时采用24小时格式,如:20160101160758675;

user-params:请求参数。Get请求格式为:xx=xx&xx=xx。Post请求格式为json字符串。并对参数进行URL的UTF-8编码

authorization: 鉴权码,其中,鉴权码(authorition)=dc:{apikey}:{signature}。鉴权码由三部分组成,他们之间以英文冒号隔开;(详细请参考2.2)

2.1.3 响应

1. 响应报文媒体类型为application/json;charset=utf-8.

2.     2.2、鉴权信息

apikey

管理人员分配

secretkey

管理人员分配

 

 

 

 

authorization:

第一部分:固定值为dc。

第二部分:用户申请的apikey。

第三部分:数据签名(signature)。

例如:

dc:test-apikey:ODExQUJENUFCRTBDQTc5NzM4RkQ2RTUzQzE2MDQyNUY=

数据签名(signature),加密格式如下:

signature=

BASE64{

Hmac_sha1{

user-params + 换行符

+ user-date + 换行符

}

}

数据签名由hmac_sha1加密后在经base64编码。hmac_sha1密钥为用户申请的secretkey。}

 

user-date

用日期。格式yyyyMMddHHmmssSSS。17位日期字符串,小时采用24小时格式,如:20160101160758675;

 

user-params

请求参数。Get请求格式为:xx=xx&xx=xx。Post请求格式为json字符串。

并对参数进行URL的UTF-8编码

3.     2.3API接口调用示例

API调用示例代码:

下载Api调用示例,把代码导入开发工具,查看其中的RequestApiTest类,修改其中的 APIKEY,SECRETKEY,然后根据相应的请求方式,修改接口地址进行测试。

 

 

 

 

3      接口清单

 

3.1获取资源类型

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetResourceType

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

 

 

 

出参

请求示例

 

返回示例

{

  "success": true,

  "resultCode": 200,

  "resultDesc": "调用成功",

  "result": [

    {

      "ID": "3A0061E007BA0ECDCAA2D1A7D9943F49",

      "Name": "教案"

    },

    {

      "ID": "3A0061E007BA4A34C4B649862A26FD1F",

      "Name": "课件"

    },

    {

      "ID": "3A0061E007BAD156AFC0C16F175A4E6C",

      "Name": "电子课本"

    },

    {

      "ID": "3A0061E007BAE90A14FAB25AE69EB489",

      "Name": "习题"

    },

    {

      "ID": "3A0061E007BAEB9E2BA3C14EAB6C16AA",

      "Name": "教学视频"

    },

    {

      "ID": "3A0061E88FF3B3635308F195340BB754",

      "Name": "研修"

    },

    {

      "ID": "3A00AF6A7D6D0E26848568552DDA8CAC",

      "Name": "其他"

    }

  ]

}






 

3.2获取知识点

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/LibList

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

 

 

 

出参

 

请求示例

 

返回示例

{

  "resultDesc": "sed enim in tempor Lorem",

  "success": false,

  "resultCode": -84959581,

  "result": [

    {

      "shareQuestionCount": 1917837,

      "sort": -20702656,

      "children": [],

      "level": -55082339,

      "id": "100",

      "name": "在容任消间",

      "parentID": "86",

      "onlyQuestionCount": 10011207

    },

    {

      "id": "12",

      "parentID": "63",

      "children": [],

      "sort": 20669948,

      "shareQuestionCount": -77821000,

      "onlyQuestionCount": 70074687,

      "level": 62197806,

      "name": "加标重"

    },

    {

      "sort": 23249266,

      "onlyQuestionCount": -63371829,

      "name": "准改问酸水们",

      "parentID": "53",

      "id": "56",

      "level": -98148369,

      "shareQuestionCount": -24875357,

      "children": []

    },

    {

      "name": "东即定说织",

      "level": 2054032,

      "shareQuestionCount": 21114203,

      "children": [],

      "id": "99",

      "onlyQuestionCount": -26129952,

      "parentID": "57",

      "sort": -77708344

    },

    {

      "shareQuestionCount": 24176951,

      "children": [],

      "level": -61947549,

      "id": "2",

      "parentID": "34",

      "name": "西次常况学",

      "onlyQuestionCount": -9977797,

      "sort": 99391355

    }

  ]

}






 

3.3根据学科获取资源数量

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetNumOfSubject

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

 

 

 

出参

 

请求示例

 

返回示例

{

  "success": true,

  "resultCode": 200,

  "resultDesc": "调用成功",

  "result": [

    {

      "SubjectName": "语文",

      "Num": 47

    },

    {

      "SubjectName": "数学",

      "Num": 48

    },

    {

      "SubjectName": "英语",

      "Num": 8

    }

  ]

}






 

3.4/编辑资源

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/CreateRescource

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

token

Stirng

header位置上传

出参

 

请求示例

 

返回示例

{

  "resultDesc": "laboris officia",

  "resultCode": 53254422,

  "result": true,

  "success": false

}






 

3.5获取教科书数据

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetTextBookGrade

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

 

 

 

出参

 

请求示例

 

返回示例

{

  "success": true,

  "resultCode": 200,

  "resultDesc": "调用成功",

  "result": [

    {

      "value": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

      "label": "数学",

      "children": [

        {

          "value": "3A004DD5C820C6B925811592E9C56810",

          "label": "苏教版",

          "children": [

            {

              "value": "3A0061E88FF312E4231585C7834933BC",

              "label": "五上"

            }

          ]

        },

        {

          "value": "3A004DD7D8113BCDD9F46A07742DDC59",

          "label": "人教版",

          "children": [

            {

              "value": "3A0061E88FF331A7B425EA37371838D3",

              "label": "四下"

            },

            {

              "value": "3A0061E007BA4735837BD43A29BFB930",

              "label": "一上"

            }

          ]

        }

      ]

    },

    {

      "value": "3A0061E007BA2A02579C5C4313837F59",

      "label": "英语",

      "children": [

        {

          "value": "3A004DD7D8113BCDD9F46A07742DDC59",

          "label": "人教版",

          "children": [

            {

              "value": "3A0061EDC5A7F735ACEDA59B6D5AFE4D",

              "label": "九下"

            },

            {

              "value": "3A0061EDC5A70C35CB6E0CF118E91681",

              "label": "九上"

            }

          ]

        }

      ]

    },

    {

      "value": "3A0061E007BAE5BCD5813984CFF553DF",

      "label": "语文",

      "children": [

        {

          "value": "3A004DD5C820C6B925811592E9C56810",

          "label": "苏教版",

          "children": [

            {

              "value": "3A0061E007BA4735837BD43A29BFB930",

              "label": "一上"

            }

          ]

        },

        {

          "value": "3A00A6517587A591E686897A4810CE27",

          "label": "部编",

          "children": [

            {

              "value": "3A0061EDC5A7EAEFBBC0BFE28B47D809",

              "label": "七上"

            }

          ]

        }

      ]

    },

    {

      "value": "39F766472E16B8498565343400DB32DD",

      "label": "物理",

      "children": [

        {

          "value": "3A004DD7D8113BCDD9F46A07742DDC59",

          "label": "人教版",

          "children": [

            {

              "value": "3A0061EDC5A73DA5B7D2D69DCF5FF032",

              "label": "八下"

            },

            {

              "value": "39FFD2AB560E9A211C842D0369454DBB",

              "label": "必修一"

            }

          ]

        }

      ]

    },

    {

      "value": "3A0061E007BAD026614178009453B7AE",

      "label": "道德与法制",

      "children": [

        {

          "value": "3A004DD5C820C6B925811592E9C56810",

          "label": "苏教版",

          "children": [

            {

              "value": "3A0061E88FF312E4231585C7834933BC",

              "label": "五上"

            },

            {

              "value": "3A0061EDC5A70C35CB6E0CF118E91681",

              "label": "九上"

            }

          ]

        }

      ]

    }

  ]

}






 

3.6获取书本大纲

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetTextBookCatalogue

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

 

 

 

出参

 

请求示例

 

返回示例

{

  "success": true,

  "resultCode": 200,

  "resultDesc": "调用成功",

  "result": [

    {

      "AttributeSubjectID": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

      "AttributePublisherID": "3A004DD5C820C6B925811592E9C56810",

      "AttributeAlbumID": "3A0061E88FF312E4231585C7834933BC",

      "CreaterID": "3A008747EAC2C767507111256D5A910A",

      "Type": 1,

      "Id": "39F7666AAF9445549836183B9254F0EF",

      "Level": 1,

      "Children": [

        {

          "AttributeSubjectID": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

          "AttributePublisherID": "3A004DD5C820C6B925811592E9C56810",

          "AttributeAlbumID": "3A0061E88FF312E4231585C7834933BC",

          "CreaterID": "3A008747EAC2C767507111256D5A910A",

          "Type": 2,

          "Id": "3A0061F5B677E9889059E94C9DEA1AA3",

          "Value": "测试示例",

          "ParentId": "39F7666AAF9445549836183B9254F0EF",

          "Level": 2,

          "Text": "测试示例"

        },

        {

          "AttributeSubjectID": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

          "AttributePublisherID": "3A004DD5C820C6B925811592E9C56810",

          "AttributeAlbumID": "3A0061E88FF312E4231585C7834933BC",

          "CreaterID": "3A008747EAC2C767507111256D5A910A",

          "Type": 2,

          "Id": "3A006D47529458B574A0AF30D08E8FCB",

          "Value": "测试",

          "ParentId": "39F7666AAF9445549836183B9254F0EF",

          "Level": 2,

          "Text": "测试"

        }

      ]

    }

  ]

}






 

3.7资源查询接口

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetAllResource

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

token

Stirng

header位置上传

出参

 

请求示例

 

返回示例

{

  "success": true,

  "resultCode": 200,

  "resultDesc": "调用成功",

  "result": {

    "list": [

      {

        "KnowLedgeLibName": "声音的产生",

        "KnowledgeLibID": "39FF1ED095527DCE276F44CF4022306F",

        "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

        "OrganizationID": "3A006C3A19C0ED1CE73F7188B2D709AD",

        "ResourceType": 0,

        "ID": "3A00B985D475FAFEE3AC81E4382CDA75",

        "Type": "1",

        "File": {

          "SN": 0,

          "FileName": "c16b1ed58e9b10f55d2ea971e39ba6a5",

          "Bucket": "axsfile",

          "FilePath": "RescourceFile",

          "Extention": "doc",

          "FileMD5": "c16b1ed58e9b10f55d2ea971e39ba6a5",

          "Type": 0,

          "Size": 2155,

          "Name": "新建文本文档6.doc",

          "ID": "3A00B985D4762E872F9B25BF54B71133"

        },

        "DownloadNum": 2,

        "Name": "testfile (副本)",

        "UserID": "3A006C595B96A5F1AC2EAD387FF2587B",

        "UserName": "夏智超",

        "DateTime": "2021-12-11T11:00:58.457354",

        "CreateTime": "2021-12-11T10:36:06.642106",

        "Degree": 2,

        "Size": 2155,

        "BrowseNum": 0,

        "LaudNum": 0,

        "CollectNum": 0,

        "ShareNum": 0,

        "ReleaseStatus": 0,

        "IsShelf": 1,

        "Source": "夏智超",

        "LookRange": "仅自己可见",

        "IsApply": 1,

        "IsLaud": 2,

        "IsCollect": 2,

        "AttributeTypeID": "3A0061E007BA4A34C4B649862A26FD1F",

        "TypeName": "课件",

        "TextBooks": [

          {

            "CatalogueID": "3A006D47529458B574A0AF30D08E8FCB",

            "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

            "Name": "ceshi",

            "SubjectID": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

            "SubjectName": "数学",

            "PublisherID": "3A004DD5C820C6B925811592E9C56810",

            "PublisherName": "苏教版",

            "AlbumID": "3A0061E88FF312E4231585C7834933BC",

            "AlbumName": "五上"

          },

          {

            "CatalogueID": "3A0061F5B677E789292420F1FCF42B91",

            "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

            "Name": "位置",

            "SubjectID": "3A0061E007BA2A02579C5C4313837F59",

            "SubjectName": "英语",

            "PublisherID": "3A004DD7D8113BCDD9F46A07742DDC59",

            "PublisherName": "人教版",

            "AlbumID": "3A0061EDC5A7F735ACEDA59B6D5AFE4D",

            "AlbumName": "九下"

          }

        ]

      },

      {

        "KnowLedgeLibName": "声音的产生",

        "KnowledgeLibID": "39FF1ED095527DCE276F44CF4022306F",

        "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

        "OrganizationID": "3A0062C84975EF74F285E4935C3557F7",

        "ResourceType": 0,

        "ID": "3A00C4D9F833F63E8F7D0D2B55A352BE",

        "Type": "1",

        "File": {

          "SN": 0,

          "FileName": "c16b1ed58e9b10f55d2ea971e39ba6a5",

          "Bucket": "axsfile",

          "FilePath": "RescourceFile",

          "Extention": "doc",

          "FileMD5": "c16b1ed58e9b10f55d2ea971e39ba6a5",

          "Type": 0,

          "Size": 2155,

          "Name": "新建文本文档6.doc",

          "ID": "3A00B985D4762E872F9B25BF54B71133"

        },

        "DownloadNum": 2,

        "Name": "testfile (副本)",

        "UserID": "3A006C595B96A5F1AC2EAD387FF2587B",

        "UserName": "夏智超",

        "DateTime": "2021-12-11T11:00:58.457354",

        "CreateTime": "2021-12-11T10:36:06.642106",

        "Degree": 2,

        "Size": 2155,

        "BrowseNum": 0,

        "LaudNum": 0,

        "CollectNum": 0,

        "ShareNum": 0,

        "ReleaseStatus": 0,

        "IsShelf": 1,

        "Source": "夏智超",

        "LookRange": "仅自己可见",

        "IsApply": 1,

        "IsLaud": 2,

        "IsCollect": 2,

        "AttributeTypeID": "3A0061E007BA4A34C4B649862A26FD1F",

        "TypeName": "课件",

        "TextBooks": [

          {

            "CatalogueID": "3A006D47529458B574A0AF30D08E8FCB",

            "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

            "Name": "ceshi",

            "SubjectID": "3A0061E007BA3AD84D58A0BA2AAFF8EC",

            "SubjectName": "数学",

            "PublisherID": "3A004DD5C820C6B925811592E9C56810",

            "PublisherName": "苏教版",

            "AlbumID": "3A0061E88FF312E4231585C7834933BC",

            "AlbumName": "五上"

          },

          {

            "CatalogueID": "3A0061F5B677E789292420F1FCF42B91",

            "ResourceID": "3A00B985D4726F3C969BE7A73CB9691D",

            "Name": "位置",

            "SubjectID": "3A0061E007BA2A02579C5C4313837F59",

            "SubjectName": "英语",

            "PublisherID": "3A004DD7D8113BCDD9F46A07742DDC59",

            "PublisherName": "人教版",

            "AlbumID": "3A0061EDC5A7F735ACEDA59B6D5AFE4D",

            "AlbumName": "九下"

          }

        ]

      }

    ],

    "pager": {

      "PageNumber": 1,

      "PageSize": 2,

      "SortField": "string",

      "SortType": "string",

      "Total": 135,

      "Pages": 68,

      "IsFirstPage": true,

      "IsLastPage": false

    }

  }

}






 

3.8用户登陆 token登录

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/LoginOfOut

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

出参

请求示例

 

返回示例

 






 

3.9获取OssToken

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetOssToken

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

出参

请求示例

 

返回示例

 






 

3.10获取Oss上传路径枚举

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetOssPathes

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

 

出参

请求示例

 

返回示例

 






 

3.11获取登录人信息

接口访问地址

http://open-api.longyanedu.net/rescourceCenter/GetCustomer

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

出参

请求示例

 

返回示例

 






 


评论

还能输入140

用户评论

龙岩市教育局主办     技术运营支持:福建智慧海西信息技术有限公司   
Copyright©2022 www.longyanedu.net All rights reserved      ICP备案号: 闽ICP备09006768号

经过核实,本空间由于存在敏感词或非法违规信息或不安全代码或被其他用户举报,
已被管理员(或客服)锁定。
本空间现无法正常访问,也无法进行任何操作。
如需解锁请联系当地教育技术部门,由当地教育技术部门联系锁定人处理。

当前机构空间已被管理员(或客服)封锁。
目前机构空间无法正常访问,也无法进行任何操作。
如需重新开放,请联系当地教育技术部门,由当地教育技术部门联系管理员(或客服)处理。