目 录 1 概 述 链 接 式 页 面 对 接 对 接 目 标 添 加 页 面 链 接 实 现 方 式 添 加 页 面 链 接 实 现 方 式 工 作 流 程 嵌 入 式 搜

Transcription

1 北 京 市 数 字 教 育 资 源 管 理 与 共 享 交 换 平 台 对 接 技 术 规 范 北 京 教 育 网 络 和 信 息 中 心 2015 年 1 月

2 目 录 1 概 述 链 接 式 页 面 对 接 对 接 目 标 添 加 页 面 链 接 实 现 方 式 添 加 页 面 链 接 实 现 方 式 工 作 流 程 嵌 入 式 搜 索 框 对 接 对 接 目 标 对 接 内 容 检 索 框 嵌 入 实 现 方 式 检 索 框 嵌 入 实 现 方 式 工 作 流 程 紧 耦 合 式 API 对 接 对 接 目 标 对 接 内 容 资 源 查 询 对 接 元 数 据 读 取 对 接 资 源 浏 览 查 看 对 接 实 现 方 式 资 源 查 询 对 接 实 现 方 式 元 数 据 读 取 对 接 实 现 方 式 资 源 浏 览 查 看 对 接 实 现 方 式 工 作 流 程 接 口 说 明 总 体 说 明 I

3 5.2 资 源 查 询 接 口 说 明 及 示 例 (JQuery) 元 数 据 读 取 接 口 说 明 及 示 例 (JQuery) 资 源 阅 读 查 看 接 口 说 明 及 示 例 使 用 CMIS 账 户 登 录 接 口 说 明 及 示 例 (JQuery) 元 数 据 同 步 接 口 说 明 总 体 说 明 资 源 查 询 接 口 说 明 II

4 1 概 述 2014 年, 北 京 市 教 委 启 动 了 北 京 市 数 字 教 育 资 源 管 理 与 共 享 交 换 平 台 ( 以 下 简 称 共 享 平 台 ) 建 设 工 作 至 12 月, 共 享 平 台 初 步 完 成 开 发 并 投 入 使 用 平 台 整 合 了 北 京 市 数 字 学 校 北 京 市 中 小 学 数 字 图 书 馆 北 京 市 中 小 学 电 子 教 材 网 资 源 网 百 度 文 库 等 五 个 来 源 的 约 一 百 多 万 条 数 字 资 源, 面 向 全 市 提 供 中 小 学 教 育 资 源 服 务, 平 台 访 问 地 址 : 共 享 平 台 采 用 分 布 式 架 构, 资 源 文 件 保 存 于 各 个 资 源 服 务 单 位 ; 资 源 元 数 据 通 过 交 换 平 台 集 中 至 市 级 共 享 交 换 平 台 的 目 录 库, 即 通 过 逻 辑 汇 聚 实 现 对 各 个 平 台 资 源 的 统 一 管 理 和 检 索 服 务 具 体 如 下 图 所 示 : 图 1-1 北 京 市 数 字 资 源 共 享 交 换 平 台 应 用 模 式 图 目 前, 共 享 平 台 已 经 完 成 同 各 个 市 级 资 源 提 供 单 位 系 统 的 用 户 访 问 对 接, 用 户 通 过 共 享 交 换 平 台 检 索 到 感 兴 趣 的 数 字 资 源 元 数 据 后, 可 以 通 过 接 口 直 接 跳 转 至 资 源 浏 览 查 看 页 面, 即 实 现 了 用 户 登 录 的 无 缝 对 接 另 外, 为 便 于 开 展 面 向 区 县 学 校 的 资 源 汇 聚 与 共 享, 共 享 交 换 平 台 提 供 了 资 源 检 索 及 查 看 服 务 接 口, 各 个 区 县 学 校 及 其 他 第 三 方 应 用 开 发 厂 商 可 以 通 过 接 口, 调 取 市 级 资 源, 将 市 级 资 源 嵌 入 至 本 区 县 学 校 或 企 业 的 各 类 资 源 应 用 系 统 中 为 满 足 各 区 县 学 校 不 同 的 资 源 共 享 要 求, 平 台 对 现 有 接 口 进 一 步 规 范, 提 供 了 页 面 对 接 搜 索 框 对 接 元 数 据 对 接 三 种 方 式 页 面 对 接 是 指 区 县 学 校 及 其 他 第 三 方 应 用 开 发 厂 商 在 开 发 的 应 用 系 统 中 以 添 加 一 个 共 享 交 换 平 台 访 问 链 1

5 接, 实 现 各 应 用 系 统 对 共 享 交 换 平 台 资 源 的 直 接 访 问 搜 索 框 对 接 是 指 将 共 享 交 换 平 台 的 搜 索 框 直 接 嵌 入 各 类 应 用 系 统 中, 实 现 对 共 享 交 换 平 台 资 源 检 索 的 方 式 元 数 据 对 接 是 指 应 用 系 统 通 过 接 口, 调 取 共 享 交 换 平 台 数 据, 并 根 据 各 自 系 统 需 求, 进 行 个 性 化 的 展 示 和 集 成 的 方 式 页 面 对 接 相 对 容 易 实 现, 但 用 户 需 要 跳 转 系 统 后 才 能 进 行 检 索, 对 接 融 合 程 度 不 高 搜 索 框 嵌 入 对 接 方 式 也 比 较 容 易 实 现, 只 需 要 嵌 入 一 小 段 代 码 即 可 实 现, 但 检 索 结 果 需 要 在 共 享 交 换 平 台 中 显 示, 和 本 地 系 统 融 合 程 度 也 不 深 元 数 据 对 接 方 式 中, 本 地 系 统 可 以 完 全 根 据 系 统 需 求 进 行 个 性 化 集 成 展 示, 融 合 程 度 高, 用 户 体 验 好, 但 相 对 前 两 种 方 式 有 一 定 开 发 量 查 询 和 显 示 方 面, 一 般 开 发 时 间 大 约 为 2-3 天 ; 用 户 对 接 方 面, 如 果 学 校 区 县 第 三 方 系 统 已 支 持 OAuth2 开 放 有 协 议, 则 无 需 开 发, 只 需 要 配 置 即 可 ; 如 不 支 持 OAuth2 协 议, 需 要 定 制 开 发 一 个 用 户 认 证 接 口, 时 间 一 般 在 2-3 天 ; 共 享 交 换 平 台 对 接 文 档 中 也 提 供 了 完 整 的 对 接 程 序 示 例, 供 开 发 人 员 参 考 各 区 县 学 校 可 根 据 自 身 需 求 与 开 发 量 酌 情 选 择 上 述 三 种 方 式 上 述 三 种 对 接 方 式 的 目 标 内 容 实 施 流 程 等 详 细 介 绍 如 下 用 户 对 接 具 体 接 口 详 见 联 合 身 份 认 证 对 接 技 术 规 范 2 链 接 式 页 面 对 接 2.1 对 接 目 标 页 面 对 接 为 各 区 县 学 校 系 统 提 供 市 级 共 享 平 台 链 接, 实 现 从 各 系 统 到 市 级 平 台 首 页 的 直 接 跳 转 登 录 添 加 页 面 链 接 在 学 校 的 应 用 系 统 中, 添 加 一 个 访 问 共 享 交 换 平 台 的 链 接, 用 户 点 击 链 接 后 页 面 跳 转 到 共 享 交 换 平 台 门 户 2.2 实 现 方 式 添 加 页 面 链 接 实 现 方 式 在 学 校 区 县 或 第 三 方 应 用 上 开 发 的 应 用 系 统 中 加 入 共 享 交 换 平 台 链 接, 链 接 地 址 为 : 2

6 2.3 工 作 流 程 共 享 交 换 平 台 页 面 对 接 工 作 流 程 如 下 图 所 示 : 链 接 式 网 站 链 接 对 接 流 程 图 区 县 学 校 第 三 方 应 用 系 统 区 县 学 校 第 三 方 系 统 统 一 身 份 认 证 系 统 (CAS/Oauth) 共 享 交 换 平 台 市 级 统 一 身 份 认 证 系 统 (CMIS) 开 始 本 学 校 系 统 市 级 资 源 栏 目 点 击 共 享 交 换 平 台 链 接 是 否 已 登 录? N 本 校 的 统 一 身 份 认 证 系 统 (CAS Oauth) 登 录 页 设 置 用 户 session 记 录 用 户 Access Token Y 重 定 向 到 共 享 交 换 平 台 首 页 url Url+accessToken+appid 通 过 Access Token 返 回 用 户 名 信 息 解 析 Access Token 共 享 交 换 平 台 首 页 映 射 用 户 到 CMIS 账 户 ( 自 动 登 录 CMIS) 登 录 验 证 返 回 CMIS TokenID 结 束 图 2-1 链 接 式 页 面 对 接 工 作 流 程 共 享 交 换 平 台 和 各 个 区 县 学 校 第 三 方 系 统, 通 过 市 级 身 份 认 证 系 统 (CMIS) 身 份 认 证 实 现 页 面 对 接 的 流 程 如 下 所 述 : (1) 用 户 访 问 区 县 学 校 第 三 方 系 统 ( 本 地 系 统 ) 的 市 级 资 源 栏 目 ; (2) 用 户 点 击 市 级 共 享 交 换 平 台 链 接 ; (3) 验 证 用 户 是 否 登 录 如 已 登 录, 则 本 地 系 统 直 接 跳 转 到 共 享 交 换 平 台 首 页 ; 若 用 户 尚 未 登 录 本 地 系 统, 则 跳 转 到 本 校 统 一 身 份 认 证 系 统 ( 如 CAS 系 统 ); (4) 登 录 成 功 后 统 一 身 份 认 证 系 统 应 返 回 一 个 Access Token 给 本 地 系 统 ; 本 地 系 统 设 置 用 户 session, 记 录 Access Token; (5) 共 享 交 换 平 台 根 据 Access Token, 通 过 OAuth2 协 议, 读 取 用 户 的 用 户 名 ; (6) 共 享 交 换 平 台 记 录 用 户 名, 并 自 动 绑 定 该 用 户 到 一 个 缺 省 的 CMIS 账 户 ; (7) 共 享 交 换 平 台 用 缺 省 账 户 登 录 CMIS 身 份 认 证 系 统, 并 从 CMIS 中 获 取 其 返 回 的 CMIS 的 TokenID; (8) 共 享 交 换 平 台 将 从 CMIS 获 取 TokenID 附 加 到 首 页 的 实 际 地 址 上, 并 重 3

7 定 向 用 户 到 此 实 际 地 址 (9) 完 成 共 享 平 台 首 页 跳 转 及 登 录, 用 户 即 可 凭 借 当 前 用 户 身 份 浏 览 操 作 市 级 平 台 3 嵌 入 式 搜 索 框 对 接 3.1 对 接 目 标 嵌 入 式 搜 索 框 对 接 为 各 区 县 学 校 系 统 提 供 市 级 平 台 检 索 结 果 页 面 共 享 各 系 统 通 过 嵌 入 一 个 市 级 资 源 检 索 框, 即 可 在 点 击 检 索 后 跳 转 到 市 级 平 台 的 检 索 结 果 页 面 3.2 对 接 内 容 嵌 入 式 搜 索 框 对 接 方 式 通 过 二 级 页 面 实 现 与 市 级 平 台 的 共 享, 因 此 有 一 定 的 开 发 量, 涉 及 两 项 工 作, 一 是 检 索 框 嵌 入, 二 是 用 户 对 接 检 索 框 嵌 入 3.3 实 现 方 式 检 索 框 嵌 入 实 现 方 式 方 式 1: 网 站 开 发 人 员 将 搜 索 功 能 的 URL( 插 入 到 其 网 站 的 某 一 位 置 后, 就 可 以 实 现 搜 索 框 的 功 能 嵌 入 方 式 2: 网 站 开 发 人 员 将 搜 索 功 能 的 HTML 代 码 拷 贝 插 入 到 其 网 站 的 某 一 位 置 后, 就 可 以 实 现 搜 索 框 的 功 能 嵌 入 如 需 对 搜 索 框 样 式 等 做 出 调 整, 可 以 自 行 修 改 两 种 方 式 点 击 搜 索 后 都 跳 转 到 共 享 平 台 的 查 询 列 表 页 面 跳 转 时 参 数 : 表 3-1 跳 转 参 数 表 序 号 名 称 说 明 是 否 必 须 1 providerid 联 合 身 份 认 证 服 务 提 供 商 标 识, 默 认 使 用 学 校 区 县 或 第 三 方 域 名 或 者 IP 作 为 联 合 身 份 认 证 是 服 务 提 供 商 标 识 2 appkey 接 入 平 台 应 用 标 识, 如 该 应 用 要 接 入 教 委 云 平 台, 由 联 合 身 份 认 证 平 台 提 供 给 学 校 区 县 否 第 三 方 应 用 3 k 检 索 关 键 词 是 4 accesstoken 登 录 令 牌 用 户 在 区 县 学 校 第 三 方 应 用 登 否 4

8 录 后 获 取 的 访 问 令 牌, 根 据 该 令 牌 教 委 共 享 平 台 调 用 第 三 方 应 用 接 口 可 以 得 到 当 前 登 录 到 区 县 学 校 第 三 方 应 用 的 用 户 信 息 ; 获 取 需 要 登 录 的 资 源 信 息 时 需 传 递 该 参 数 用 户 登 录 时 必 须 示 例 : 方 式 1:iframe 嵌 入, 使 用 共 享 平 台 默 认 样 式 <!DOCTYPE html> <html> <head> <title>demo.html</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"> </head> <body> <iframe src=" frameborder="0" height="200" width="400" /> </body> </html> 方 式 2:HTML 代 码 嵌 入,CSS 样 式 可 根 据 需 要 任 意 修 改 <!DOCTYPE html> <html> <head> <title> 北 京 市 数 字 教 育 资 源 管 理 与 共 享 交 换 平 台 </title> <meta http-equiv="content-type" content="text/html; charset=utf-8"> </head> <body onload="document.getelementbyid('k').focus()"> <form title=" 北 京 市 数 字 教 育 资 源 管 理 与 共 享 交 换 平 台 " id="rspsearcher" action=" providerid= 联 合 身 份 认 证 服 务 提 供 商 标 识 &appkey= 接 入 应 用 标 识 &accesstoken= 第 三 方 身 份 认 证 系 统 " target="_blank"> <table bgcolor="#ffffff" style="width: 100%;"> <tr> <td nowrap="nowrap" style="width: 64px"><div style="display: block;width: 64px;height: 37px;background: url(' no-repeat left top;"></div></td> <td><input style="width: 100%;height: 34px;line-height: 34px;font-size: 20px;border: 1px solid #dbdbdb;padding-left: 24px;background-color: white;background: 5

9 url(' no-repeat left center;" type="text" id="k" name="k" size="50"/></td> <td style="width: 80px;" nowrap="nowrap"><input type="submit" value="" style="border: 0;cursor: pointer;width: 77px;height: 38px;background: url(' no-repeat left top;"></td> </tr> </table> </form> </body> </html> 实 例 地 址 : 3.4 工 作 流 程 共 享 交 换 平 台 搜 索 框 对 接 工 作 流 程 如 下 图 所 示 : 嵌 入 式 搜 索 框 嵌 入 对 接 流 程 图 区 县 学 校 第 三 方 应 用 系 统 区 县 学 校 第 三 方 系 统 统 一 身 份 认 证 系 统 (CAS/Oauth) 共 享 交 换 平 台 市 级 统 一 身 份 认 证 系 统 (CMIS) 开 始 本 学 校 系 统 的 市 级 资 源 检 索 框 用 户 输 入 关 键 字 搜 索 市 级 资 源 是 否 已 登 录? N 本 校 的 统 一 身 份 认 证 系 统 (CAS Oauth) 登 录 页 设 置 用 户 session 记 录 用 户 Access Token Y 重 定 向 到 共 享 交 换 平 台 首 页 url Url+accessToken+appid 解 析 Access Token 通 过 Access Token 返 回 用 户 名 信 息 共 享 交 换 平 台 列 表 页 映 射 用 户 到 CMIS 账 户 ( 自 动 登 录 CMIS) 登 录 验 证 返 回 CMIS TokenID 结 束 图 3-1 嵌 入 式 搜 索 框 对 接 工 作 流 程 共 享 交 换 平 台 和 各 个 区 县 学 校 第 三 方 系 统, 通 过 市 级 身 份 认 证 系 统 (CMIS) 实 现 搜 索 框 对 接 的 流 程 如 下 所 述 : (1) 用 户 访 问 区 县 学 校 第 三 方 系 统 ( 本 地 系 统 ), 在 市 级 资 源 搜 索 框 中 输 入 关 键 字 进 行 检 索 ; 6

10 (2) 调 用 市 级 资 源 查 询 接 口, 共 享 平 台 返 回 检 索 结 果 页 面 ; (3) 用 户 点 击 市 级 共 享 交 换 平 台 链 接 ; (4) 验 证 用 户 是 否 登 录 如 已 登 录, 则 本 地 系 统 直 接 跳 转 到 共 享 交 换 平 台 首 页 ; 若 用 户 尚 未 登 录 本 地 系 统, 则 跳 转 到 本 校 统 一 身 份 认 证 系 统 ( 如 CAS 系 统 ); (5) 登 录 成 功 后 统 一 身 份 认 证 系 统 应 返 回 一 个 Access Token 给 本 地 系 统 ; 本 地 系 统 设 置 用 户 session, 记 录 Access Token; (6) 共 享 交 换 平 台 根 据 Access Token, 通 过 OAuth2 协 议, 读 取 用 户 的 用 户 名 ; (7) 共 享 交 换 平 台 记 录 用 户 名, 并 自 动 绑 定 该 用 户 到 一 个 缺 省 的 CMIS 账 户 ; (8) 共 享 交 换 平 台 用 缺 省 账 户 登 录 CMIS 身 份 认 证 系 统, 并 从 CMIS 中 获 取 其 返 回 的 CMIS 的 TokenID; (9) 共 享 交 换 平 台 将 从 CMIS 获 取 TokenID 附 加 到 首 页 的 实 际 地 址 上, 并 重 定 向 用 户 到 此 实 际 地 址 (10) 完 成 共 享 平 台 检 索 结 果 页 面 跳 转 及 登 录, 用 户 即 可 凭 借 当 前 用 户 身 份 浏 览 操 作 市 级 平 台 检 索 结 果 页 面 4 紧 耦 合 式 API 对 接 4.1 对 接 目 标 紧 耦 合 式 API 对 接 为 各 区 县 学 校 系 统 提 供 市 级 平 台 的 资 源 元 数 据, 并 在 各 系 统 的 检 索 结 果 列 表 页 和 资 源 详 情 页 中 展 示 各 系 统 在 进 行 资 源 检 索 时, 可 在 市 级 平 台 的 元 数 据 库 中 进 行 检 索, 市 级 平 台 返 回 检 索 结 果 后, 显 示 在 各 系 统 的 检 索 结 果 列 表 页 中 ; 同 时, 进 入 详 情 页 时, 显 示 由 市 级 平 台 返 回 的 详 情 页 面 元 数 据 4.2 对 接 内 容 该 方 式 需 根 据 对 接 的 元 数 据 内 容, 开 发 本 系 统 的 检 索 结 果 列 表 页 和 资 源 详 情 页, 但 可 以 充 分 实 现 对 市 级 平 台 资 源 的 共 享, 涉 及 用 户 对 接 资 源 查 询 访 问 对 接 元 数 据 对 接 资 源 浏 览 查 看 对 接 四 部 分 内 容 资 源 查 询 对 接 资 源 查 询 对 接 主 要 是 利 用 接 口, 通 过 关 键 词 和 各 类 过 滤 条 件, 查 询 共 享 交 换 平 台 中 的 数 字 资 源, 并 获 取 查 询 结 果 列 表 7

11 4.2.2 元 数 据 读 取 对 接 资 源 元 数 据 读 取 对 接 主 要 是 指 根 据 共 享 交 换 平 台 中 数 字 资 源 的 标 识 号, 读 取 标 识 号 对 应 资 源 的 详 细 元 数 据 信 息 的 对 接 资 源 浏 览 查 看 对 接 资 源 浏 览 查 看 对 接 主 要 是 指 通 过 接 口, 查 看 某 一 资 源 的 实 体 文 件 的 对 接 4.3 实 现 方 式 资 源 查 询 对 接 实 现 方 式 共 享 交 换 平 台 提 供 了 基 于 RESTFUL 的 资 源 查 询 访 问 方 式, 区 县 学 校 第 三 方 系 统 可 以 通 过 RESTFUL 方 式, 直 接 通 过 url 或 者 web post 方 式 查 询 资 源 调 取 元 数 据, 也 可 以 通 过 平 台 提 供 的 Javascript 脚 本, 访 问 资 源 详 细 接 口 说 明 见 元 数 据 读 取 对 接 实 现 方 式 元 数 据 读 取 对 接 根 据 资 源 查 询 接 口 返 回 数 据 的 id 查 询 元 数 据 的 详 细 信 息 详 细 接 口 说 明 见 资 源 浏 览 查 看 对 接 实 现 方 式 资 源 浏 览 查 看 对 接 通 过 返 回 的 元 数 据 中 包 含 的 阅 读 和 查 看 地 址, 拼 接 本 地 系 统 用 户 信 息 后 跳 转 到 共 享 平 台 资 源 查 看 地 址 进 行 浏 览 查 看 等 操 作 详 细 接 口 说 明 见 工 作 流 程 共 享 交 换 平 台 耦 合 式 API 对 接 工 作 流 程 如 下 图 所 示 : 8

12 耦 合 式 API 对 接 接 流 程 图 区 县 学 校 第 三 方 应 用 系 统 区 县 学 校 第 三 方 系 统 统 一 身 份 认 证 系 统 (CAS/Oauth) 共 享 交 换 平 台 市 级 资 源 提 供 系 统 ( 数 字 学 校 数 字 图 书 馆 资 源 网 等 ) 市 级 统 一 身 份 认 证 系 统 (CMIS) 开 始 本 学 校 系 统 的 市 级 资 源 栏 目 用 户 输 入 关 键 字 搜 索 市 级 资 源 共 享 平 台 返 回 资 源 列 表 本 地 系 统 显 示 资 源 列 表 用 户 点 击 一 条 资 源 本 地 系 统 展 示 元 数 据 信 息 ( 包 括 资 源 阅 读 访 问 的 url) 共 享 平 台 返 回 资 源 元 数 据 信 息 用 户 点 击 阅 读 访 问 链 接 该 资 源 是 否 需 要 登 录 查 看? N 用 户 是 否 已 经 登 录? N 本 校 的 统 一 身 份 认 证 系 统 (CAS Oauth) 登 录 页 N 设 置 用 户 session 记 录 用 户 Access Token Y 重 定 向 用 户 到 共 享 交 换 平 台 资 源 查 看 URL+token=null 重 定 向 到 共 享 交 换 平 台 资 源 阅 读 url Url+accessToken+appid 解 析 Access Token 记 录 日 志 重 定 向 到 资 源 阅 读 地 址 通 过 Access Token 返 回 用 户 名 信 息 Oauth2 验 证 映 射 用 户 到 CMIS 账 户 ( 自 动 登 录 CMIS) 登 录 验 证 返 回 CMIS TokenID 接 收 新 的 访 问 地 址 (url+cmis TokenID) 跳 转 到 资 源 提 供 方 将 CMIS 的 tokentid 返 回 到 用 户 资 源 访 问 url 查 阅 播 放 资 源 地 址 验 证 cmistoken 验 证 cmistoken 阅 读 资 源 返 回 资 源 阅 读 页 结 束 图 4-1 耦 合 式 API 对 接 工 作 流 程 共 享 交 换 平 台 和 各 个 区 县 学 校 第 三 方 系 统, 经 市 级 身 份 认 证 系 统 (CMIS) 身 份 认 证 进 行 资 源 访 问 和 浏 览 的 流 程 如 下 所 述 : (1) 用 户 访 问 区 县 学 校 第 三 方 系 统 ( 本 地 系 统 ) 的 市 级 资 源 栏 目 ; (2) 用 户 输 入 关 键 字 搜 索 市 级 资 源 ; (3) 本 地 系 统 通 过 接 口 搜 索 共 享 交 换 平 台 中 的 资 源 ; (4) 共 享 交 换 平 台 返 回 查 询 结 果 资 源 数 据 ; (5) 本 地 系 统 构 建 资 源 显 示 列 表 ; (6) 用 户 点 击 一 条 资 源 ; (7) 本 地 系 统 通 过 元 数 据 接 口 访 问 共 享 交 换 平 台, 获 取 该 条 资 源 的 元 数 据 信 息 ; (8) 共 享 交 换 平 台 返 回 资 源 元 数 据 信 息 9

13 (9) 本 地 系 统 展 示 元 数 据 信 息 ; (10) 用 户 点 击 阅 读 按 钮, 如 果 该 资 源 是 免 费 资 源, 不 需 要 登 录, 则 本 地 系 统 直 接 跳 转 到 共 享 交 换 平 台 的 资 源 访 问 代 理 页 面 访 问 资 源 ; 如 果 该 资 源 为 非 免 费 资 源, 需 要 登 录 后 访 问, 且 用 户 尚 未 登 录 本 地 系 统, 则 跳 转 到 本 校 统 一 身 份 认 证 系 统 ( 如 CAS 系 统 ); (11) 登 录 成 功 后 统 一 身 份 认 证 系 统 应 返 回 一 个 Access Token 给 本 地 系 统 ; 本 地 系 统 设 置 用 户 session, 记 录 Access Token (12) 本 地 系 统 将 AccessToken 附 加 到 资 源 阅 读 url 后, 重 定 向 用 户 跳 转 到 共 享 交 换 平 台 的 资 源 阅 读 url (13) 共 享 交 换 平 台 根 据 Access Token, 通 过 OAuth2 协 议, 读 取 用 户 的 用 户 名 ; (14) 共 享 交 换 平 台 记 录 用 户 名, 并 自 动 绑 定 该 用 户 到 一 个 缺 省 的 CMIS 账 户 ; (15) 共 享 交 换 平 台 用 缺 省 账 户 登 录 CMIS 身 份 认 证 系 统, 并 从 CMIS 中 获 取 其 返 回 的 CMIS 的 TokenID; (16) 共 享 交 换 平 台 将 从 CMIS 获 取 TokenID 附 加 到 资 源 访 问 的 实 际 地 址 上, 并 重 定 向 用 户 到 此 实 际 地 址 (17) 用 户 访 问 资 源 实 际 地 址, 资 源 提 供 方 根 据 CMIS 的 TokenId 到 CMIS 验 证 用 户 信 息 验 证 通 过, 允 许 访 问 资 源 10

14 5 接 口 说 明 5.1 总 体 说 明 共 享 交 换 平 台 和 区 县 学 校 第 三 方 系 统 的 对 接 接 口 共 包 括 5 个, 其 中 四 个 由 共 享 交 换 平 台 提 供, 一 个 由 区 县 学 校 第 三 方 系 统 提 供 接 口 介 绍 如 下 : 5.2 资 源 查 询 接 口 说 明 及 示 例 (JQuery) 该 接 口 主 要 提 供 输 入 关 键 词 查 询 元 数 据 列 表 服 务 地 址 : 请 求 参 数 : 表 5-1 资 源 查 询 接 口 请 求 参 数 表 序 号 名 称 说 明 是 否 必 须 1 providerid 联 合 身 份 认 证 服 务 提 供 商 标 识, 默 认 使 用 学 校 区 县 或 第 三 方 域 名 或 者 IP 作 为 是 联 合 身 份 认 证 服 务 提 供 商 标 识 2 appkey 接 入 平 台 应 用 标 识, 如 该 应 用 要 接 入 教 委 云 平 台, 由 联 合 身 份 认 证 平 台 提 供 给 否 学 校 区 县 第 三 方 应 用 3 k 查 询 关 键 词 是 4 jsoncallback 固 定 值? 是 5 pagesize 翻 页 查 询 每 页 数 量 可 选 默 认 10 6 start 开 始 记 录 数 可 选 默 认 0 7 parametermap.xduan 学 段, 取 值 为 字 典 编 码, 如 : 01- 代 可 选, 对 接 时 表 小 学 单 独 提 供 8 parametermap.kmu 科 目, 取 值 为 字 典 编 码, 如 : 可 选, 对 接 时 代 表 数 学 单 独 提 供 9 parametermap.bben 版 本, 取 值 为 字 典 编 码, 如 : 可 选, 对 接 时 代 表 北 京 版 单 独 提 供 10 parametermap.nji 年 级, 取 值 为 字 典 编 码, 如 : 可 选, 对 接 时 代 表 一 年 级 上 册 单 独 提 供 11 parametermap.mlu 目 录, 取 值 为 字 典 编 码, 如 代 表 一 可 选, 对 接 时 数 学 就 在 我 身 边 单 独 提 供 登 录 令 牌 用 户 在 区 县 学 校 第 三 方 应 用 登 录 后 获 取 的 访 问 令 牌, 根 据 该 令 12 accesstoken 牌 教 委 共 享 平 台 调 用 第 三 方 应 用 接 口 可 以 得 到 当 前 登 录 到 区 县 学 校 第 三 方 应 用 的 用 户 信 息 ; 获 取 需 要 登 录 的 资 源 信 息 时 需 传 递 该 参 数 否 11

15 返 回 参 数 : 表 5-2 资 源 查 询 接 口 返 回 参 数 表 序 号 名 称 说 明 1 totalcount 总 记 录 数 2 start 开 始 记 录 数 3 pagesize 每 页 记 录 数 4 totalpage 总 页 数 5 data 数 据 列 表 5.1 id 资 源 id 5.2 title 名 称 5.3 nodename 来 源 5.4 detailurl 详 细 地 址 URL 5.5 summary 摘 要 5.6 provider 贡 献 者 5.7 publishdate 发 布 日 期 5.8 avgscore 资 源 评 分 5.9 scusercount 评 分 人 数 示 例 代 码 (JQuery): function search() { var url = ' var k = encodeuri(' 数 学 '); $.getjson(url + '?k=' + k + '& parametermap.xduan=01-&jsoncallback=?', function(json) { alert(json); }); } 注 : 前 提 引 用 jquery.js 返 回 JSON 数 据 示 例 : { "data" : [ { 12

16 "avgscore" : 0, "detailurl" : " c8e7ab3565", "id" : "c91025dff9824a588ca598c8e7ab3565", "nodename" : " 百 度 文 库 ", "provider" : null, "publishdate" : " ", "scusercount" : "0", "summary" : null, "title" : " 人 教 版 小 学 语 文 一 年 级 上 册 一 去 二 三 里 PPT 课 件 <font color='#e8372e'>123</font>" ], } } "pagesize" : 10, "start" : 0, "totalcount" : 42, "totalpage" : 5 实 例 地 址 : 5.3 元 数 据 读 取 接 口 说 明 及 示 例 (JQuery) 该 接 口 主 要 根 据 5.3 节 资 源 查 询 接 口 返 回 数 据 的 id 查 询 元 数 据 的 详 细 信 息 服 务 地 址 : 请 求 参 数 : 表 5-3 元 数 据 读 取 接 口 请 求 参 数 表 序 号 名 称 说 明 是 否 必 须 1 providerid 联 合 身 份 认 证 服 务 提 供 商 标 识, 默 认 使 用 学 校 区 县 或 第 三 方 域 名 或 者 IP 作 为 联 合 身 份 认 证 服 务 是 提 供 商 标 识 2 appkey 接 入 平 台 应 用 标 识, 如 该 应 用 要 接 入 教 委 云 平 台, 由 联 合 身 份 认 证 平 台 提 供 给 学 校 区 县 第 否 13

17 三 方 应 用 3 id 资 源 ID 是 4 jsoncallback 固 定 值? 是 登 录 令 牌 用 户 在 区 县 学 校 第 三 方 应 用 登 录 后 获 取 的 访 问 令 牌, 根 据 该 令 牌 教 委 共 享 平 台 调 5 accesstoken 用 第 三 方 应 用 接 口 可 以 得 到 当 前 登 录 到 区 县 学 校 第 三 方 应 用 的 用 户 信 息 ; 获 取 需 要 登 录 的 资 源 信 息 时 需 传 递 该 参 数 否 返 回 参 数 : 表 5-4 元 数 据 读 取 接 口 返 回 参 数 表 序 号 名 称 说 明 1 id 资 源 id 2 title 名 称 3 nodename 来 源 4 detailurl 详 细 地 址 URL 5 summary 摘 要 6 provider 贡 献 者 7 publishdate 发 布 日 期 8 avgscore 资 源 评 分 9 scusercount 评 分 人 数 10 keyword 关 键 词 11 islogin 是 否 需 登 录 true: 需 要 登 录 false 不 需 要 登 录 12 viewurl 查 看 页 面 URL, 请 求 参 数 accesstoken 有 值 且 验 证 合 法 则 返 回 ; 可 能 为 空 13 readurl 阅 读 页 面 URL, 请 求 参 数 accesstoken 有 值 且 验 证 合 法 则 返 回 ; 可 能 为 空 示 例 代 码 : function detail() { var url = ' json/bjmrsp/detailjson.do?id=3092a29f72ee4565b5bc331ab2bc24e3&jsoncal lback=?'; $.getjson(url, function(json) { if (json) { alert(json); } }); 14

18 } 返 回 JSON 数 据 示 例 : { "avgscore" : 0, "id" : "3092a29f72ee4565b5bc331ab2bc24e3", "keyword" : " 信 息 技 术 ", "nodename" : " 中 小 学 数 字 图 书 馆 ", "url" : " "provider" : null, "publishdate" : " ", "scusercount" : "0", "summary" : " 简 明 英 汉 信 息 技 术 词 汇 是 按 照 术 语 选 择 严 格 译 名 科 学 准 确 编 排 紧 凑 便 查 的 原 则 精 心 编 撰 而 成 的 编 者 从 十 多 年 收 集 的 近 30 万 条 信 息 技 术 词 汇 中 精 选 出 1.93 万 条, 逐 一 审 核 推 敲, 慎 重 定 名 ", "title" : " 简 明 英 汉 信 息 技 术 词 汇 " } 实 例 地 址 : 5.4 资 源 阅 读 查 看 接 口 说 明 及 示 例 本 地 系 统 通 过 元 数 据 返 回 的 阅 读 和 查 看 地 址, 加 上 本 地 身 份 认 证 系 统 的 Access Token, 跳 转 到 共 享 交 换 平 台 的 资 源 查 看 地 址 url 进 行 查 看 5.5 使 用 CMIS 账 户 登 录 接 口 说 明 及 示 例 (JQuery) 该 接 口 主 要 在 不 使 用 本 地 系 统 的 身 份 认 证 功 能, 直 接 使 用 CMIS 系 统 账 户 登 录 共 享 交 换 平 台 的 情 况 下 使 用 用 户 输 入 CMIS 系 统 的 账 户 和 密 码, 返 回 用 户 登 录 结 果 信 息 服 务 地 址 : 请 求 参 数 : 表 5-5 使 用 CMIS 账 户 登 录 接 口 请 求 参 数 表 序 号 名 称 说 明 是 否 必 须 15

19 1 providerid 联 合 身 份 认 证 服 务 提 供 商 标 识, 默 认 使 用 学 校 区 县 或 第 三 方 域 名 或 者 IP 作 为 联 合 是 身 份 认 证 服 务 提 供 商 标 识 2 appkey 接 入 平 台 应 用 标 识, 如 该 应 用 要 接 入 教 委 云 平 台, 由 联 合 身 份 认 证 平 台 提 供 给 学 校 否 区 县 第 三 方 应 用 3 loginid CMIS 统 一 身 份 认 证 登 录 账 号 是 4 password CMIS 统 一 身 份 认 证 登 录 密 码 是 5 jsoncallback 固 定 值? 是 返 回 参 数 : 表 5-6 使 用 CMIS 账 户 登 录 接 口 返 回 参 数 表 序 号 名 称 说 明 1 success Y- 成 功 ;N- 失 败 2 msg 失 败 信 息, 只 有 在 success=n 时 有 值 3 tokenid CMIS 统 一 身 份 认 证 账 号 登 录 标 识, 用 于 页 面 跳 转 时 URL 后 追 加, 实 现 单 点 登 录 效 果 4 user CMIS 统 一 身 份 认 证 系 统 返 回 的 用 户 名 示 例 代 码 : function search() { var url = ' $.getjson(url + '?loginid=abc&password=123&jsoncallback=?', function(json) { alert(json); }); } 返 回 JSON 数 据 示 例 : { "success" : "Y", "tokenid" : "AQIC5wM2LY4SfcxjXpFm-G6zqmTJ6QhbtaqlAXBmTz0WQbQ.*AAJTSQACMDEAAlN 16

20 LABM0NzY2ODQ0NTc3NjI5MjA0NTg2*", "user" : { "cn" : " 黄 佩 瑶 ", "createtime" : " ", "credenceclass" : "Credence_002", "credencestate" : "1", "inetuserstatus" : "Active", "mail" : "[email protected]", "owner" : " ,ou=people,dc=uams,dc=co", "uamsdepts" : " ,ou=organizations,dc=uam", "uamspeoplestatus" : "1", "uamsroles" : "533d73c1e2eb4becacbf52861d43d19d", "uid" : " ", "uniqueid" : " ", "useridcode" : " ", "userlogintype" : "0", "usermodpwdflag" : "1" } } 实 例 地 址 : 6 元 数 据 同 步 接 口 说 明 6.1 总 体 说 明 元 数 据 同 步 接 口 主 要 用 于 区 县 学 校 第 三 方 系 统 通 过 在 线 定 期 把 数 据 同 步 到 本 地 系 统, 然 后 定 制 自 己 的 个 性 服 务, 但 是 查 看 具 体 资 源 信 息 或 者 阅 读 资 源 文 件 的 时 候 任 然 需 要 参 考 前 面 的 接 口 说 明 进 行 查 看 接 口 介 绍 如 下 : 6.2 资 源 查 询 接 口 说 明 接 口 地 址 : 17

21 esize=100&start=1&timestap= 接 口 参 数 说 明 : 参 数 key pagesize start timestap 描 述 使 用 数 据 cdef19d014cdf093fbc0000 和 当 天 日 期 作 为 加 密 秘 钥, 例 如 通 过 DES 方 式 加 密 生 成 key 值, 生 成 结 果 : kz9rdtggdpua7/mxnzehiboozfpjgwwq+dii/g2mmpvi4mstwx0urg= = 加 密 数 据 由 平 台 提 供, 在 资 源 对 接 的 时 候 请 联 系 平 台 提 供 参 数 格 式 : 正 整 数 ; 每 次 请 求 返 回 数 据 条 数, 每 次 返 回 最 多 100 条 数 据 参 数 格 式 : 正 整 数 ; 从 数 据 库 第 X 条 数 据 开 始 查 询 参 数 格 式 : ; 查 询 该 日 期 之 后 的 数 据 18