、api访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29...

41
《》 福福福福福福福福福福福福福福 2016 福 01 福 01 福

Upload: lybao

Post on 20-Apr-2018

276 views

Category:

Documents


8 download

TRANSCRIPT

Page 1: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

《福建省教育资源公共服务平台第三方应用接入规范》

福建中教网络教育服务有限公司2016 年 01 月 01 日

Page 2: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

目 录

第一部分 第三方应用谈判规范.................................................................................4

1.1 福建省教育资源公共服务平台概况.............................................................4

1.1.1 中教网公司简介.................................................................................4

1.1.2 福建省教育资源公共服务平台简介..................................................4

1.2 省平台虚拟币运营模式概述.........................................................................5

1.2.1 省平台虚拟币介绍..............................................................................5

1.2.2 省平台虚拟币计费机制......................................................................6

1.3、第三方应用的合作模式.............................................................................6

1.3.1 第三方应用在平台上的展现..............................................................7

1.4、第三方应用接入的步骤.............................................................................8

1.4.1 准入评审阶段.....................................................................................8

1.4.2 商务洽谈阶段.....................................................................................9

1.4.3 应用接入阶段...................................................................................12

1.4.4 上线运营阶段...................................................................................13

第二部分 第三方应用界面设计规范........................................................................14

2.1、第三方应用图标规格与规范....................................................................14

2.2、第三方应用前台页面设计规范................................................................15

2.3、第三方应用关于用户头像的获取和尺寸说明........................................16

2

Page 3: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

第三部分 第三方应用技术接口规范........................................................................16

5.1、API 访问鉴权.............................................................................................16

5.2、应用支付...................................................................................................17

5.3、单点登录...................................................................................................19

5.2、接口列表...................................................................................................29

5.1、接口参考...................................................................................................31

5.1.1API 访问鉴权接口..............................................................................31

5.2.1 用户接口...........................................................................................32

5.3.1 支付接口...........................................................................................33

5.4.1 消息接口...........................................................................................34

第四部分 第三方应用合作商的运营模式................................................................36

4.1、省平台运营支持.......................................................................................36

4.2、第三方应用合作商需要配合的运营内容................................................36

4.3、第三方应用运营管理规范.......................................................................36

4.4、第三方应用运营中的内容规范要点........................................................38

第五部分 第三方应用合作商的管理........................................................................38

5.1 第三方应用合作商准入机制.......................................................................38

5.2 第三方应用合作商日常维护.......................................................................39

附件一:省平台第三方应用合作协议模版.............................................................43

附件二:省平台第三方应用保密协议模版.............................................................43

附件三:省平台第三方应用界面设计规范.............................................................43

3

Page 4: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

附件四:省平台第三方应用技术接口规范.............................................................43

第一部分 第三方应用谈判规范

1.1 福建省教育资源公共服务平台概况1.1.1 中教网公司简介

福建中教网络教育服务有限公司,是福建省教育厅直属事业单位福建教育

杂志社的国有控股企业。公司受福建省教育厅委托,结合创新性、可行性市场

商业模式主导运营“福建省教育资源公共服务平台”,公司以实现“教育信息

化、教育均衡化、教育可持续化”为企业的战略目标,努力以信息化为手段扩

大优质教育资源在福建省内的覆盖面,以“三通两平台”的实现作为信息技术

与教育教学深度融合的落脚点,为创建“人人皆学、处处能学、时时可学”的

学习型社会而持续奋斗!

1.1.2 福建省教育资源公共服务平台简介

福建省教育资源公共服务平台(以下简称“省平台”)是福建省教育厅为4

Page 5: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

贯彻落实中央有关教育信息化的战略部署,完成《国家中长期教育改革和发展

规划纲要(2010-2020 年)》确定的教育信息化目标任务的重要落脚点。福

建省教育厅直属单位旗下的福建中教网络教育服务有限公司受福建省教育厅委

托,负责福建省教育资源公共服务平台运营等相关工作。福建省教育资源公共服务平台是“三通两平台”的核心环节,平台以“人

人通”空间为基础,以应用为驱动,融合创新,构建教育教学新生态,建设集

机构、教师、学生、家长与应用厂商五位一体的服务云平台,努力打造具有福

建特色的”互联网+八闽 e 学堂“教育品牌。平台面向机构、教师、学生、家长提供管理、教学、学习和成长四大类应

用服务。平台的教师空间为教师提供教学、交流与学情数据管理的一站式服务

中心。平台的学校空间及班级空间不仅为学校及班级提供了便捷的日常教务管

理信息化窗口,同时,也为学校提供了校园知识与文化沉淀的“智能数据库”,

为学校文化建设、资源沉淀、教学成长、校本管理及后期的大数据统计分析奠

定了的基础。平台还囊括了学科社区、专题社区和名师工作室,由教研员、名

5

Page 6: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

师引领教师参与,共同打造“探究式”、“讨论式”、“参与式”的教育社区,

促进优质资源共建共享,扩大优质资源的覆盖面,从而促进教育教学公平。

1.2 省平台虚拟币运营模式概述1.2.1 省平台虚拟币介绍

虚拟币代替实体货币流通的信息流或数据流,是省平台上的通用虚拟货币,

用于平台计费以及各个应用和服务计费,是平台结算的重要依据。用户通过三种方式获得虚拟币:(一) 第一种为福建省教育厅或地方政府通过当地教育局向各类教育用户

6

Page 7: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

充值。(二) 第二种方式为通过提供优质资源到平台后交易给其他用户使用获取。(三) 第三种方式为通过人民币购买。

兑换规则为 1元人民币=1 虚拟币(具体兑换规则以省厅发放虚拟币前敲定的为准)。虚拟币的作用对象包括:机构、学校、教师、家长和学生。

1.2.2 省平台虚拟币计费机制

省平台采用虚拟币的计费方式,平台所有应用明确标注使用该应用的虚拟

币计费单价。

7

Page 8: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

第三方应用是平台上全部应用和服务的一种方式。第三方应用合作商与平

台承建方按照合作分成的模式进行合作,按照虚拟币计费的方式进行结算。以老师、学生(一次或者包月)有效使用标记虚拟币价格的第三方应用的

为计费基础,第三方应用合作商对用户有效使用虚拟币的(消费行为以及消费

额度)进行汇总,每一季度或者每 4个月与省平台管理运营方(福建中教网络

教育服务有限公司)进行消费额度与消费行为进行对账,按照合作协议的分成

比例进行结算。

1.3、第三方应用的合作模式省平台主要包括基础设施层、平台层、空间以及门户,省平台也是开放的

平台,第三应用也是在不断聚合和优化。福建中教网络教育服务有限公司欢迎

与教育行业资深合作商一起,共同建设合作共赢的省平台。

8

Page 9: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.3.1 第三方应用在平台上的展现

省平台上的应用是指由通过平台运营机制汇聚的第三方开发商提供的满足

用户教学需求的应用程序。用户主要通过省平台进入应用市场,看到所有的应用。

9

Page 10: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.4、第三方应用接入的步骤成为省平台(管理运营方:福建中教网络教育服务有限公司)应用合作商需

要完成以下几步主要步骤:

1.4.1 准入评审阶段

由福建省教育厅委托省平台的管理运营方福建中教网络教育服务有限公司

成立评审组,评审小组成员不少于 3组,1) 公司领导成员组;2) 教育产品研

发组;3) 公司其他临时成员组。对第三方应用产品的界面、功能、接入方式、

商业模式当前应用成功案例等进行评定打分,通过初评的第三方应用可以获准

10

Page 11: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

接入省平台。

1.4.1.1 第三方合作商提交资料

公司资质(1)公司营业执照 复印件加盖公章(2)公司税务登记证 复印件加盖公章(3)公司组织机构代码证 复印件加盖公章

产品资料(1)产品技术方案说明书 每一产品分为针对教育局和学校技术方案。

(以 word或者 ppt文档提供)(2)产品的销售方式和商业模

式按该公司一直遵循的商业模式和销售方式提供。(以 word或者 ppt文档提供)

(3)产品对外报价体系 (价格要求为该公司日常报价),另外给我们的最低成本价格体系应提供单独一份文档(以 excel 格式提供)

(4)产品试用账号和测试网址 每个产品试用账号不少于 3个。(以 excel

格式提供)(5) 产品成功案例讲解 每一产品不少于 1个成功案例介绍。

11

Page 12: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.4.2 商务洽谈阶段

1.4.2.1 收益途径

途径 描述 计费方式应用 接入 分

成模式

利用平台开放 KPI,为平台修改、定

制、开发应用插件进行应用分成。

按平台虚拟币使用情况计

费 , 可 以按次数、按包

月。

1.4.2.2 分成比例

以应用商与福建省中教网络教育服务有限公司商谈后为准。

1.4.2.3 分成条件

条件一 通过福建中教网络教育服务有限公司对第三方应用审核以及第三方

应用合作商的资格审核,正式成为平台第三方应用接入商。(参见

7.1)条件二 第三方应用合作商与福建中教网络教育服务有限公司签订了合作协

12

Page 13: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

议。条件三 第三方应用接入满足上线基本要求(完成第二阶段接入),并且正

式上线试用期满以后,开始产生计费。

1.4.2.3 结算准备

准备一 从正式计费开始时间算起——到结算之日,用户使用应用的行为表

格,使用次数,用户信息以及行为,计费统计表。(第三方应用商

提供)准备二 由平台产生的用户使用应用的历史数据表格,使用次数,用户信息

以及行为,计费统计表。(福建中教网络教育服务有限公司提供)准备三 第三方应用合作商与福建中教网络教育服务有限公司对账统计,开

具发票,提供合作协议附件和主合同复印件,可以开始支付分成费

用。

举例说明:假设福建省 2016 年预算省平台虚拟资金池有 5000万虚拟币,按照老师、

13

Page 14: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

学生每人每月预存 200元虚拟币的方式,在平台上自由交易。第三方应用按照福建中教网络教育服务有限公司同意的标价或者叫做定价

(按次或者包月)按照用户实际使用次收费,每月进行有效使用记录和额度与

福建中教网络教育服务有限公司进行对账。例如:某一应用每月实际使用总额为 500000 虚拟币,分成比例:40%:

60%,实际人民币收益为:500000 * 60% * 1/100 = 30000元第三方应用可以按季度或者每 4个月进行虚拟币总对账和实际分成比例人民

币结算。

申请成为省平台应用合作商,还要需要经过第三方合作商的资质核实,

(参见 7.1)最终与福建中教网络教育服务有限公司达成统一的商务合作意向 。

并且提交以下文档为应用接入阶段做准备。(一) 根据省平台制定的相关标准及技术文档,开发应用。(二) 搭建应用的测试环境,完成应用的联调和测试。(三) 双方创建工作组由双方指定商务、产品、技术对接人,明确联系方式和

权限划分。14

Page 15: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.4.3 应用接入阶段

省平台与达成合作协议的第三方应用厂商的应用接入深入合作主要分为三

个阶段:(一) 完成应用单点登录流程;完成应用在省平台上的核心部署,确保接入功

能的正常使用。时间周期 4~7天。(应用实现单点登录是省厅要求的必要

条件)(二) 按照接入规范完成平台和应用的数据的互通,完成平台基于虚拟币的支

付体系、用户数据、资源数据等方面的互通。同时按照省平台 UCD 规范完

成应用界面改造。按照省平台的需求完成应用在空间上的组件开发和接口

开发。时间周期 15~30天。(三) 完成第二阶段接入的应用合作厂商才可以参与省平台基于虚拟币的结算。(四) 实现省平台与应用的教育资源,用户基本行为数据、运营数据的互通。

同时配合省平台在全国的部署规模,完成省平台应用开放平台搭建过程中

合作厂商需要做的变更。

15

Page 16: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.4.4 上线运营阶段

在与合作方签订了合作协议之后,福建中教网络教育服务有限公司在对合作

应用功能做初步的评估后与合作方共同订制三期接入计划。每一期的接入步骤主要包括:由以上提到的双方创建的工作组中产品负责人

共同制订当期的接入方案;合作商按照接入节点和接入规范完成研发工作;双

方就接入产品完成接口和功能的联调,在完成测试流程后方可上线。

为确保接入省平台应用的质量、提高后续运营服务的稳定性,应用接入工

16

Page 17: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

作需要按照本规范进行。各个应用厂商需要对应用进行仔细检查及测试,对于

不符合规范项进行修改,以提高应用的商业价值。

第二部分 第三方应用界面设计规范

(详见附件三)

2.1 第三方应用图标规格与规范1.规格

应用申请上线时,需要提供以下规格的图标:图标规格 图标大小

px单位: KB单位:

应用小图标 32×32 <20 png应用大图标 64×64 <20 png

图标类型 图标格式

2.规范:(1)图片简洁清晰,重点突出,界面层次清晰。(2)必须透明底色,并参考省平台应用图标设计。(3)图片不得添加“new、hot、热、推荐”等标注。(4)图片不得直接或间接使用福建中教网络教育服务有限公司或其它公司图

案元素。17

Page 18: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(5)图片中如需添加文字,文字应与应用名称和应用内容相符。

2.2 第三方应用前台页面设计规范1. 应用进行页面设计时,页面内容宽度为 960px。各版块之间间距不低于

10px。(如下图)

2. 应用背景一律用白色。

3.参考省平台 GUI 规范(详见附件三)。

4.关于浏览器兼容应 用 必 须 考 虑 浏 览 器 兼 容 问 题 , 需 要 兼 容

18

Page 19: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

IE6/7/8、chrome、firefox、360 等主流浏览器,无样式问题。

2.3 第三方应用关于用户头像的获取和尺寸说明目前头像只能通过OpenAPI 的方式来获取到用户头像的 URL。需要注意的是,在应用上线前,接口返回的头像 URL 有防盗链。上线后,

才会开放防盗链的限制。

第三部分 第三方应用技术接口规范

具 体 参 照 附 件 四 《 福 建 教 育 资 源 公 共 服 务 平 台 3.0 开 放 API 接 口 规 范

V1.0》。

5.1 API 访问鉴权1.介绍

API调用时,应用向省平台请求 token,省平台分配 Token 信息并指明有

效期,只要在 Token 有效期内,应用无需重新发起 Token申请,被调用方在第

一次接收 Token 时发起验证请求,并保存 token 信息和有效期,只要在 Token

19

Page 20: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

有效期内,后续调用就无需再向省平台申请 Token验证。

2.应用场景

1.用户使用应用。2.应用执行处理逻辑。3.应用使用 APPID,时间戳等参数向平台请求访问 TOKEN。4.平台向应用返回访问 TOKEN。5.应用携带访问 TOKEN请求调用平台 API。

20

Page 21: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

6.平台对 TOKEN进行校验并处理 API调用请求,向应用返回调用结果。

5.2、应用支付1.介绍

用户购买应用中商品,应用向省平台发起扣费,省平台扣取用户云币,并

根据商务合同分成规则向应用所属合作伙伴帐户存入相应云币。

2.应用场景

21

Page 22: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.用户在应用购买学习资料。2.应用携带参数扣费相关参数重定向省平台进行扣费。3.省平台页面提示用户扣费,展示所购物品和费用相关信息。4.用户在扣费页面确认扣费。5.省平台扣取用户云币,将扣费结果返回到应用。6.省平台后台通知应用扣费结果。7.应用向省平台返回扣费结果处理结果。

5.3、单点登录1.介绍

福建省教育资源公共服务平台集成多个业务系统,平台的前端展示门户对

用户实现统一登录入口,只要在福建省教育资源公共服务平台登录的用户在福

建省教育资源公共服务平台与各业务系统间不需要多次登录,进而实现对所有

被授权的网络资源进行无缝访问了。

2.单点登录场景

22

Page 23: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

1.用户登录省平台门户。2.省平台保存用户会话信息,在浏览器COOKIE 中保存用户 TGC 信息。3.用户在省平台选择应用,省平台将用户重定向至应用。4.用户在应用内访问受保护资源,应用将用户重定向至省平台。5.省平台从浏览器中获取用户 TGC 信息,并根据 TGC校验用户会话。6.省平台生成 ST,并携带 ST将用户从省平台重定向至应用。7.应用使用 ST请求平台校验。8.平台向应用返回校验结果及用户信息。

23

Page 24: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

3.单点登录配置(1)Java语言客户端配置

1.先把 ssoclient.jar引入到项目的工程中(一般是 lib)目录。2.在项目 web.xml文件添加以下内容

<!--过滤器负责用户的认证工作,必须启用它 --><filter>

<filter-name>SSOFilter</filter-name><filter-class>

com.whty.aam.client.authentication.AuthenticationFilter</filter-class><init-param>

<param-name>casServerLoginUrl</param-name><param-value><!—此处配置用户登录的地址-->

http://192.168.1.99:8088/aam/login</param-value><!--这里的 server是服务端的 IP-->

</init-param><init-param>

<param-name>serverName</param-name><param-value>http://192.168.1.99:8088</param-value>

</init-param></filter><filter-mapping>

<filter-name>SSOFilter</filter-name><url-pattern>/*</url-pattern>

</filter-mapping>

24

Page 25: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

<!--以下配置的过滤器负责对 Ticket的校验工作,必须启用它 --><filter>

<filter-name>vlidationFilter</filter-name><filter-class>

com.whty.aam.client.validation.Cas20ProxyReceivingTicketValidationFilter

</filter-class><init-param>

<param-name>casServerUrlPrefix</param-name><!—此处配置 url地址是 AAM服务器地址,如:

http://ip:port/aam/ticketValidate 该地址用来对 ticet的验证--> <param-value>http://192.168.1.99:8088/aam/ticketValidate</param-value>

</init-param><init-param>

<param-name>serverName</param-name><param-value>http://192.168.1.99:8088</param-value>

</init-param></filter><filter-mapping>

<filter-name>vlidationFilter</filter-name><url-pattern>/*</url-pattern>

</filter-mapping>

25

Page 26: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

<!--用于单点退出配置,通知其他应用单点登出--><listener>

<listener-class>

com.whty.aam.client.session.SingleSignOutHttpSessionListener</listener-class>

</listener><!--该过滤器用于实现单点登出功能,可选配置。 --><filter>

<filter-name>SingleSignOutFilter</filter-name><filter-class>

com.whty.aam.client.session.SingleSignOutFilter</filter-class>

</filter><filter-mapping>

<filter-name>SingleSignOutFilter</filter-name><url-pattern>/*</url-pattern>

</filter-mapping>

26

Page 27: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

<!--该过滤器负责实现 HttpServletRequest请求的包裹,比如允许开发者通过 HttpServletRequest的 getRemoteUser()方法获得

SSO登录用户的登录名,可选配置。--><filter>

<filter-name>httpServletRequestWrapperFilter</filter-name><filter-class>

com.whty.aam.client.util.HttpServletRequestWrapperFilter</filter-class>

</filter><filter-mapping>

<filter-name>httpServletRequestWrapperFilter</filter-name><url-pattern>/*</url-pattern>

</filter-mapping><filter>

<filter-name>AssertionThreadLocalFilter</filter-name><filter-class>

com.whty.aam.client.util.AssertionThreadLocalFilter</filter-class>

</filter><filter-mapping>

<filter-name>AssertionThreadLocalFilter</filter-name><url-pattern>/*</url-pattern>

</filter-mapping>

3.项目中取得 ticket

可 用 request.getSession().setAttribute("ticket", ticket) ; 用

ticket这名称从 ssession 中取得 ticket。4.取得用户的 usessionid

可用 com.whty.aam.client.authentication.AttributePrincipal 这

27

Page 28: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

个类AttributePrincipal principal =

(AttributePrincipal)request.getUserPrincipal();String usessionid = principal.getName();

(2)net语言流程说明

客户 端配置需 要拦截单 点 登 录 请 求 (如: http://127.0.0.1:8080/

sso/*),但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登

录 URL 地 址 : http://test.eduyun.cn:10000/index.php?

r=portal/user/login&service=http://127.0.0.1:8080/

ssotest;URL拼写说明:service 参数是用户登录后门户重定到客户端的地

址,此参数必传不能缺失;此处使用 http://127.0.0.1:8080/ssotest 为例

子,需根据实际地址修改替换。用户在门户成功登录认证后,门户会根据 service 参数地址重定向到客户端

(service 参数传递的 URL地址),并在 URL地址后增加 ticket 参数。如:http://127.0.0.1:8080/ssotest? ticket=********

客户端获取到 ticket值,重定向到用户中心验证 ticket 有效和合法性, url

28

Page 29: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

请求格式为:http://61.183.248.37:10003/aam/ticketValidate?

ticket=SO6YEWI93093UTYDVXBZ4513==。URL拼写说明:URL 中 IP 与端口可替换实际的 ip 与端口,ticket 参数是用

户中心要求必传不能缺失.客户端请求平台验证 ticket,通过验证 ticket 的有

效性,服务端校验通过后,会销毁该一次性 ticket,并返回已登录用户名。返

回验证后的的XML报文。验证通过的报文<cas:serviceResponse

xmlns:cas='http://www.whty.aam.com'><cas:authenticationSuccess><cas:user>testss10</cas:user></cas:authenticationSuccess></cas:serviceResponse>

验证不通过的报文<cas:serviceResponse

xmlns:cas='http://www.whty.aam.com'><cas:authenticationFailure code='INVALID_TICKET'>

 Ticket SO6YEWI93093UTYDVXBZ4513== not recognized

</cas:authenticationFailure></cas:serviceResponse>

29

Page 30: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

客户端解释XML报文对验证通过的报文取<cas:user>节点的值获取到当前

登录的用户 usessionid。客户端收到校验通过后的报文,取得用户 usessionid,根据 usessionid 建

立本地的用户会话。会话时间可默认为一小时,或根据需要具体配置.客户端再

根据 usessionid 调用平台接口取得当前用户的用户信息。

(3)其它语言配置流程说明客户 端配置需 要拦截单 点 登 录 请 求 (如:http://127.0.0.1:8080/

sso/*),但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登

录 URL 地 址 : http://test.eduyun.cn:10000/index.php?

r=portal/user/login&service=http://127.0.0.1:8080/

ssotest;URL拼写说明:service 参数是用户登录后门户重定到客户端的地

址,此参数必传不能缺失;此处使用 http://127.0.0.1:8080/ssotest 为例

子,需根据实际地址修改替换。用户在门户成功登录认证后,门户会根据 service 参数地址重定向到客户端

30

Page 31: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(service 参数传递的 URL地址),并在 URL地址后增加 ticket 参数。如:http://127.0.0.1:8080/ssotest? ticket=********

客户端获取到 ticket值,重定向到用户中心验证 ticket 有效和合法性, url

请求格式为:http://61.183.248.37:10003/aam/ticketValidate?

ticket=SO6YEWI93093UTYDVXBZ4513==。URL拼写说明:URL 中 IP 与端口可替换实际的 ip 与端口,ticket 参数是用

户中心要求必传不能缺失.客户端请求平台验证 ticket,通过验证 ticket 的有

效性,服务端校验通过后,会销毁该一次性 ticket,并返回已登录用户名。返

回验证后的的XML报文。验证通过的报文<cas:serviceResponse

xmlns:cas='http://www.whty.aam.com'><cas:authenticationSuccess><cas:user>testss10</cas:user></cas:authenticationSuccess></cas:serviceResponse>

验证不通过的报文<cas:serviceResponse

xmlns:cas='http://www.whty.aam.com'>

31

Page 32: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

<cas:authenticationFailure code='INVALID_TICKET'> Ticket SO6YEWI93093UTYDVXBZ4513== not recognized

</cas:authenticationFailure></cas:serviceResponse>

客户端解释XML报文对验证通过的报文取<cas:user>节点的值获取到当前

登录的用户 usessionid。客户端收到校验通过后的报文,取得用户 usessionid,根据 usessionid 建

立本地的用户会话。会话时间可默认为一小时,或根据需要具体配置.客户端再

根据 usessionid 调用平台接口取得当前用户的用户信息。

5.2、接口列表1.API 访问鉴权接口接口名称 接口方向 接口描述获取访问 TOKEN 应用-省平台 应用使用访问凭证获取访问令牌

2.用户接口接口名称 接口方向 接口描述获 取当前 登 录 用

户信息

应用省平台 应用根据单点登录会话 ID查询用户信息

32

Page 33: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

获 取 用 户 基本信

应用省平台 应用获取用户基本信息

批量获 取 用 户 信

应用省平台 应用批量获取添加此应用的用户信息

获取用户好友 应用省平台 应用获取用户好友列表验证是否为好友 应用省平台 应用验证两个用户是否为好友查询班级信息 应用省平台 应用根据班级 ID 获取班级信息查询班级成员信

应用省平台 应用根据班级 ID 获取班级成员信息

3.支付接口接口名称 接口方向 接口描述支付请求 应用-省平台 应用调用支付页面,请求使用云币支付页 面跳转同步 通

省平台应用 用户在省平台支付完成后,返回至应用

支付成功页面后台异步通知 省平台应用 用户在教云平台支付完成后,省平台后

33

Page 34: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

台通知应用支付结果

4.消息接口接口名称 接口方向 接口描述发送消息 应用-省平台 应用调用接口向用户发送消息

或应用以用户的身份向用户好友发送消

5.1 接口参考5.1.1API 访问鉴权接口

1.接口说明应用调用平台开放API之前,请求获取访问 TOKEN。

2.请求说明url http://ip:port/apigateway/getaccesstoken

格式 json

协议 post

是否需要鉴权 true

34

Page 35: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

请求数限制 true

接口方向 应用平台

3.参数说明参数名称 是否必须 类型 描述appid 必选 String 应用 ID

timestamp

必选 String 时间戳。keyinfo 必选 String 对 APPID 、 APPKEY 、 Timestamp 进行

sha1-hamc 运算,加密串为 APPID 和

APPKEY 及 Timestamp 字符串相连 , 以

APPKEY 为加密参数

4.返回说明返回码 含义说明000000 操作成功999999 系统错误

5.字段说明35

Page 36: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

参数名称 是否必须 类型 描述token 必选 String token 信息validtime

必选 String 有效期,只在有效期内(2小时),应用无需重

新申请,服务保存 token及有效期,有效期

内只需做一次验证。

5.2.1 用户接口

用户接口主要包涵如下项目,具体参照《福建教育资源公共服务平台 3.0

开放API 接口规范 V1.0》。(1)获取当前登录用户信息(2)获取用户基本信息(3)批量获取用户信息(4)获取用户好友(5)验证用户是否为好友(6)查询班级信息(7)查询班级成员信息

36

Page 37: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(8)用户登录(C/S 模式应用)(9)查询班级列表(10)查询班级学生

5.3.1 支付接口

支付接口主要包涵如下项目,具体参照《福建教育资源公共服务平台 3.0开放

API 接口规范 V1.0》。

(1)支付请求(2)页面跳转同步通知(3)后台异步通知(4)订购鉴权

5.4.1消息接口

1.发送消息(1)接口说明

应用调用此接口向用户发送消息37

Page 38: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(2)请求说明url http://ip:port/eduServer2/api/mc/post

格式 --

协议 post

是否需要鉴权 true

请求数限制 true

接口方向 应用—>平台

(3)参数说明序号 字段名 约束 类型 长度 说明1 appid 必选 String 50 应用标识

2 sid 可选 String 50

发送消息人会话标识当以 用户身份发送消息时,此参数必选

3 c 必选 String 500 消息内容3 titile 可选 String 100 消息标题

4 type 必选 String 10

remind/znx

remind 应用消息znx私信

4 toFans 可选 发送给关注我的 人 true

38

Page 39: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

5 toUid 可选 String 50发送给指定的人取值为-1,指所用人

注:toFans 与 toUid 必须有一项是有值项。(4)返回说明序号 字段名 约束 类型 长度 说明

1 retCode 必选 String 10

结果码0:成功2:服务器内部错误3:超过最大发送次数4:消息中包含敏感字

第四部分 第三方应用合作商的运营模式

4.1 省平台运营支持针对深度整合应用合作商提供的运营支持服务。具体包括:

(一) 提供虚拟币交易体系服务支持;(二) 为应用提供多种分析数据,以供合作方应用商获取新用户,提升用户量,

提升用户对应用的黏度,促使应用快速成长;(三) 平台主题Banner 页面及其他热点区域宣传;

39

Page 40: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(四) 区校专题培训及宣传活动组织策划;(五) 完善的客服平台和指引,提高服务质量;(六) 配合教育局方和应用合作商进行产品培训和宣传。

4.2 第三方应用合作商需要配合的运营内容(一) 第三方应用合作家运营文档的支持,包括但不限于宣传文档的电子版。(二) 第三方应用合作商运营活动的支持,包括人员、宣传品的支持。(三) 第三方应用合作商对平台组织的市场活动,包括但不限于降价促销、产

品定制,厂家现场培训等给予支持。

4.3、第三方应用运营管理规范(1)为保证和维护省平台作为开放平台的服务安全,在省平台上运营的应用

发生技术类违规问题,福建中教网络教育服务有限公司有权先处理后告知;对

于其他违规,若由于该应用提供商联系信息不准确而导致无法联系的,福建中

教网络教育服务有限公司有权对发生问题的服务器做出停止运行或设备下线等

方式的处理。因此对应用造成的各类损失概由合作方应用提供商自行负责。

40

Page 41: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

(2)为了保证省平台开放平台的整体良好的运营环境,若应用异常(应用异

常情况一般包括但不限于应用无法进入,应用介绍信息与具体内容严重不符

等),则省平台方有权第一时间对该应用进行处理(为避免用户体验感不佳,

此类异常应用将挂出省平台官方维护公告,同时维护期限制用户访问)。若经初步核实,福建中教网络教育服务有限公司发现应用提供商的应用可能涉

嫌侵权的,福建中教网络教育服务有限公司有权根据自己的初步判断,对涉嫌

可能侵权的应用采取取消应用的各种推广措施和停止新、老用户的入口等措施。(3)任何违规行为应用提供商均有义务按照省平台的要求进行调整、修改等 。

对于不配合处理违规的应用提供商,省平台方有权对其违规处罚进行升级处理。

省平台开放平台有权根据应用的违规情节轻重,进行处罚调整或中止、终止应

用的运营。(4)违规信息通告可能会通过消息系统、邮箱或其他合理的方式进行通知,

请第三方应用提供商确保所提供的电子邮件地址等信息是真实、有效的,并且

未设置过滤规则,否则因此造成的一切责任由第三方应用提供商自行承担。

41

Page 42: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

应用提供商在参予省平台组织的线下推广活动的时候,应作为省平台的组成部

分,按照活动组织方的统一要求进行宣传推广。

4.4、第三方应用运营中的内容规范要点关键点 接入标准

应用名称

1、应用名不能与福建省教育资源公共服务平台中已存在应用重名。2、如应用名称涉及侵权,核实后福建省教育资源公共服务平台有权在不提前知会开发者的情况下行修改。3、应用名不能含有福建省教育资源公共服务平台自有品牌及相关元素,如省平台、资源平台、八闽 e 学堂、擎动网络、翼支付、无线城市、智慧旅游等字眼,或以“八闽 e 学堂”开头。4.应用名不能含有“黄赌毒”等低俗敏感字样。

不涉及抄袭和侵权应用不能抄袭目前福建省教育资源公共服务平台或者其它平台已上线的应用。如果福建省教育资源公共服务平台调查后确认侵权行为属实,将不能上线(即使应用已上线也将进行下线处理),相应的合作方将会列入黑名单,福建省教育资源公共服务平台不再受理其应用接入并终止合作。

无低俗敏感信息应用中已经去掉任何黄、赌、毒等相关的非法低俗内容,不含诸如“偷”、“抢”、“盗”、“杀人”等敏感字。内容涉嫌低俗内容,情节轻微给予警告并删除相应内容,情节严重将给予下线应用处罚,如触犯法律条例将依法追究责任。

第五部分 第三方应用合作商的管理

5.1 第三方应用合作商准入机制福建中教网络教育服务有限公司欢迎与教育行业资深合作商一起,共同建

42

Page 43: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

设省平台,同时也对第三方合作商进行有效的管理与准入机制。应用上线前福

建中教网络教育服务有限公司和教育厅各行政主管部门需要对应用提供商资质

进行审核。需要应用提供商提供以下公司和应用相关资料:(一) 公司相关资质:

范围 分类 项目 接入标准

资质证明

公司信息

公司名称

1、所有上传证明材料必须真实有效,提供的资料足以判断您的真实身份,不能提交虚假证件。2、合作商提供的联系人,联系电话将作为福建省教育资源公共服务平台与合作方联系的渠道,需真实有效,若虚假无效将不能提交使用

联系电话手机邮编注册时间注册资金(万元)营业执照注册号营业执照有效期至法定代表人姓名法人身份证号码电子邮箱传真税务登记号公司地址公司简介资质文件信息

资质文件信息

营业执照扫描件 1、公司合作伙伴上传营业执照的扫描件,营业执照上需要显示最新年检情况(台湾或者海外地区的营业执照也可,但应用必须是国内的版权,否则需要文化传播部的批准)。2、法人有效身份证原件的正反两面扫描件(外籍人士没有身份证请上传护照)。

机构代码证扫描件法人身份证扫描件银行开户许可证扫描件

税务登记证副本扫描件

(二) 应用相关资料:

43

Page 44: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

项目 格式 要求应用介绍说明 txt 300字以内应用标签 txt 8个字以内应用图标 png 64*64 32*32

url应用 txt url包含 地址即可

5.2 第三方应用合作商日常维护1. 省平台期待与广大第三方合作商一起,共创开放平台良好的运营环境。主

要针对以下两种情况进行监管:1) 第三方应用的设计或内容是否违反了国家法律、法规和政策规定;2) 是否滥用接口,利用接口进行未授权的非法操作。一旦发现违规情况,

将视问题的严重程度分别给予警告、关闭接口、暂时或永久关闭第三方

应用的处理。2. 违规处理原则

1) 出现情节较轻的违规问题,我们会通知第三方合作商,第三方合作商应

在规定时间内及时修改相关问题;

2) 出现较为严重的违规问题,第三方应用会被暂时关闭,第三方合作商应

及时修改问题,处理期限过后,第三方应用将重新开放;

44

Page 45: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

3) 出现严重的违法国家法律、法规和政策的问题,第三方应用会被永久关

闭,终止合作协议。3. 违规处理流程

1) 对与所有违规行为的处理,都会通过邮件或电话告知第三方合作商;

2) 在接到相关邮件后,针对具体问题及时进行修改;

3) 在规定时间内修改完毕,处理期限过后,暂时关闭的接口或第三方应用

重新开放;

4) 在规定时间内未修改完毕,会有新的处理措施,如关闭第三方应用。由

此带来的平台及用户利益损失,由第三方合作商承担全部责任。4. 违规情况及处理详细说明,参考下表:第三方违规处理细则违规情况 详细说明 处理方式 处理期限 重新开放原

则第 三 方 应 用 中出现大量违法内容

立即关闭第三方应用,终止合作协议 永久关闭 不会 重 新开

放第 三 方 应 用 中出现较多低俗、不健康

立即关闭第三方应用,终止合作协议

7-30天 删除违规 内容

45

Page 46: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

内容 完善内 容 审查系统

第 三 方 应 用 中出现少量低俗、不健康内 容 ,修改 期 限到后未修改

立即关闭第三方应用,终止合作协议 7-30天

删除违规 内容完善内 容 审查系统

泄露用户数据 立即关闭第三方应用,终止合作协议 永久关闭 不会 重 新开

放接口调用违规

第 三 方 应 用所发布的动态内容违法

立即关闭第三方应用,终止合作协议 永久关闭 不会 重 新开

放第 三 方 应 用所发布的 动 态 内 容包含竞争对手内容

关闭动态接口 7-30天 删除违规 内容

第 三 方 应 用所发布的 动 态 内 容包含竞争对手 内 容 ,累计出现 3次

立即关闭第三方应用,终止合作协议 永久关闭 不会 重 新开

利用 接 口漏洞非法获取用户数据 关闭第三方应用 永久关闭 不会 重 新开

放利用 接 口漏洞进行 关闭第三方应用 永久关闭 不会 重 新开

46

Page 47: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

开心 网未授权 的其他操作 放

运营中断

连续 24小时无法访问 第 三 方 应 用 ,未通知平台

关闭第三方应用 3天 服 务器正常访问

连续 30天无法访问第 三 方 应 用 ,未通知平台

关闭第三方应用 永久关闭 不会 重 新开放

第三方应用无人维护

第 三 方 应 用 用 户提出的问题超过 10天无人回复

警告 3天 /

第 三 方 应 用 问题警告后,超过 3 天无人回复

关闭第三方应用 7-30天

回复用 户 问题提交第 三 方应用

47

Page 48: 、API访问鉴权16 5.2、应用支付17 5.3、单点登录19 5.2、接口列表29 5.1、接口参考31 5.1.1API访问鉴权接口31 5.2.1用户接口32 5.3.1支付接口33 ...€¦ ·

附件一:省平台第三方应用合作推广协议模版

附件二:省平台第三方应用保密协议模版

附件三:省平台第三方应用界面设计规范(省平台第三方应用接入 UI/UE 规范)

附件四:省平台第三方应用技术接口规范(福建教育资源公共服务平台 3.0 开放 API 接口规范 V1.0)

48