
江西省教育资源公共服务平台.pdf
60页附件附件: :江西省教育资源公共服务平台江西省教育资源公共服务平台开放开放 APIAPI 接口规范接口规范(V1.0)江西省教育厅江西省教育厅二〇一七年九月二〇一七年九月江西省教育资源公共服务平台开放 API 接口规范(V1.0)目录前言..........................................................................................................11.范围.......................................................................................................12.术语、定义和缩略语...........................................................................23.开放平台技术架构...............................................................................34.第三方应用接入流程...........................................................................54.1 线上接入申请流程...........................................................................54.2 线下申请流程....................................................................................74.3 API 使用规范......................................................................................74.4 接入方式...........................................................................................85.应用 API 调用流程............................................................................. 115.1 OAuth2.0 简介................................................................................. 115.2 获取 API 调用 Token...................................................................... 135.3 应用接口调用.................................................................................145.3.1 公共参数...................................................................................145.3.2 接口参数...................................................................................145.3.3 示例...........................................................................................146.统一身份认证.....................................................................................156.1 概述.................................................................................................15江西省教育资源公共服务平台开放 API 接口规范(V1.0)6.2 SSO 单点登录简介...........................................................................156.3 Java 语言配置参考.........................................................................196.4 php 语言配置参考...........................................................................247.第三方数据交换.................................................................................287.1 第三方应用统计数据......................................................................287.2 第三方应用用户行为数据..............................................................287.3 第三方应用业务数据......................................................................298.接口参考.............................................................................................298.1 基础数据服务.................................................................................298.1.1获取用户信息.........................................................................298.1.2 获取班级信息............................................................................328.1.3 获取学校信息............................................................................368.1.4 获取区域信息............................................................................378.2 教育资源服务.................................................................................418.2.1 资源元数据规范.......................................................................418.2.2 数字教育资源服务接口.......................................................... 418.3 人人通空间服务.............................................................................498.3.1 个人空间接口规范...................................................................498.4 教育教学应用服务.........................................................................50江西省教育资源公共服务平台开放 API 接口规范(V1.0)8.4.1 网络备课接口............................................................................508.4.2 区域教研接口............................................................................518.4.3 公开课接口................................................................................528.5 第三方数据交换服务.....................................................................538.5.1 传递第三方平台的统计数据...................................................538.5.2 传递第三方用户行为数据....................................................... 538.5.3 传递第三方业务数据................................................................54江西省教育资源公共服务平台开放 API 接口规范(V1.0)-1-前前言言江西省教育资源公共服务平台遵循“统筹规划、统一建设、标准开放”的原则,在逻辑上建立统一的数据中心,建成覆盖全省、稳定可靠、先进适用的教育资源公共服务平台,面向各类资源及应用提供统一身份认证,数据共享、空间服务、单点登录、统一监管等基础服务,形成资源及应用汇聚共享的全省教育信息化公共服务体系。
为确保各类资源及教育应用的正确接入和应用扩展, 真正达到应用以及资源、数据的共建共享,消除信息孤岛,特制定江西省教育资源公共服务平台开放的 API 接口规范通过规范的制定和执行,在全省建立一个具有统一资源标准、 统一身份认证和统一教育资源索引的信息通道, 让优质的教育资源和信息可以在各类应用之间真正流动起来,各级师生及教育工作者在享受优质教育资源的同时,也可方便的进行沟通和交流, 充分发挥 “云” 的优势, 促进教育教学和管理创新,推进教育均衡发展, 提高整体教育质量, 支撑教育信息化可持续发展1. 范围范围本标准从技术角度资源、数据、应用等方面规定了江西省教育资源公共服务平台的集成方法,包括总体技术架构、应用接入服务、统一身份认证以及相关的服务接口参考本标准适用于各类教育资源、 应用在接入教育资源公共服务平台时参考使用江西省教育资源公共服务平台开放 API 接口规范(V1.0)-2-2. 术语、定义和缩略语术语、定义和缩略语接口接口 interfaceinterface两个功能单元之间的共享边界, 该边界由两个功能单元的功能特性、物理互连特性、信号交换特性及其他适当特性定义面向服务架构面向服务架构 service-orientedservice-oriented architecturearchitecture((SOASOA))是一个组件模型,它将应用程序的不同功能单元(称为服务)通过这些服务之间定义良好的接口和契约联系起来。
接口是采用中立的方式进行定义的。
