2《国家教育资源公共服务平台开放API接口规范》

附件2：

国家教育资源公共服务平台

开放API接口规范

1 API访问鉴权

1.1 介绍

API调用时，应用向教育云平台请求token，教育云平台分配Token信息并指明有效期，只要在Token有效期内，应用无需重新发起Token申请，被调用方在第一次接收Token时发起验证请求，并保存token信息和有效期，只要在Token有效期内，后续调用就无需再向教育云平台申请Token验证。

1.2 应用场景

2.应用处理3.使用APPID,时间戳参数获取访问TOKEN4.访问TOKEN1.使用应用5.携带访问TOKEN调用平台API6.调用结果1.用户使用应用。

2.应用执行处理逻辑。

3.应用使用APPID，时间戳等参数向平台请求访问TOKEN。

4.平台向应用返回访问TOKEN。

5.应用携带访问TOKEN请求调用平台API。

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

2 应用支付

2.1 介绍

用户购买应用中商品，应用向教育云平台发起扣费，教育云平台扣费后，根据合作伙伴商务合同分成规则，向应用所属合作伙伴帐户存入相应费用。

- 2 -

2.2 应用场景

6.扣费结果通知7.扣费结果通知返回2.扣费1.购买学习资料3.扣费页面4.扣费确认5.返回应用

1. 用户在应用购买学习资料。

2. 应用携带参数扣费相关参数重定向教育云平台进行扣费。

3. 教育云平台页面提示用户扣费，展示所购物品和费用相关信息。

4. 用户在扣费页面确认扣费。

5. 教育云平台扣费，将扣费结果返回到应用。

6. 教育云平台后台通知应用扣费结果。

7. 应用向教育云平台返回扣费结果处理结果。

3 单点登录

3.1 介绍

国家教育资源公共服务平台集成多个业务系统，平台的前端展示门户对用户实现统一登录入口，只要在国家教育资源公共服务平台登录的用户在国家教育资源公共服务平台与各业务系统间不需要多次登录，进而实现对所有被授权的网络资源进行无缝访问了。

3.2 单点登录场景

- 3 -

2.保存会话5.会话校验校验8.用户信息校验8.用户信息1.登录平台4.访问应用受保护资源，重定至平台登录3.重定向至应用4.访问应用受保护资源，重定至平台登录3.重定向至应用

1. 用户登录教育云平台门户。

2. 教育云平台保存用户会话信息，在浏览器COOKIE中保存用户TGC信息。

3. 用户在教育云平台选择应用，教育云平台将用户重向至应用。

4. 用户在应用内访问受保护资源，应用将用户重定至教育云平台。

5. 教育云平台从浏览器中获取用户TGC信息，并根据TGC校验用户会话。

6. 教育云平台生成ST，并携带ST将用户从教育云平台重定向至应用。

7. 应用使用ST请求平台校验。

8. 平台向应用返回校验结果及用户信息。

3.3 单点登录配置

3.3.1 Java语言客户端配置

1. 先把引入到项目的工程中（一般是lib）目录。

2. 在项目文件添加以下内容

- 4 -

SSOFilter

ticationFilter

casServerLoginUrl

192.168.1.99:8088/aam/login

serverName

192.168.1.99:8088

SSOFilter

/*

vlidationFilter

20ProxyReceivingTicketValidationFilter

casServerUrlPrefix

该地址用来对ticet的验证--> 192.168.1.99:8088/aam/ticketValidate

serverName

192.168.1.99:8088

vlidationFilter

/*

- 5 -

SignOutHttpSessionListener

SingleSignOutFilter

SignOutFilter

SingleSignOutFilter

/*

httpServletRequestWrapperFilter

rvletRequestWrapperFilter

httpServletRequestWrapperFilter

/*

AssertionThreadLocalFilter

ionThreadLocalFilter

AssertionThreadLocalFilter

/*

3. 项目中取得ticket

- 6 -

可用sion().setAttribute("ticket", ticket)；用ticket这名称从ssession中取得ticket。

4. 取得用户的usessionid

可用utePrincipal这个类

AttributePrincipal principal =

(AttributePrincipal)rPrincipal();

String usessionid = e();

3.3.2 .net语言流程说明

1. 客户端配置需要拦截单点登录请求（如：127.0.0.1:8080/sso/*），但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登录URL地址：:10000/?r=portal/user/login&service=127.0.0.1:8080/ssotest。

URL拼写说明：service参数是用户登录后门户重定到客户端的地址，此参数必传不能缺失；此处使用127.0.0.1:8080/ssotest为例子，需根据实际地址修改替换。

用户在门户成功登录认证后，门户会根据service参数地址重定向到客户端（service参数传递的URL地址），并在URL地址后增加ticket参数。如：127.0.0.1:8080/ssotest? ticket=********

2. 客户端获取到ticket值，重定向到用户中心验证ticket有效和合法性， url请求格式为：61.183.248.37:10003/aam/ticketValidate?ticket=

SO6YEWI93093UTYDVXBZ4513==。

URL拼写说明： URL中IP与端口可替换实际的ip与端口，ticket参数是用户中心要求必传不能缺失.客户端请求平台验证ticket，通过验证ticket的有效性，服务端校验通过后，会销毁该一次性ticket,并返回已登录用户名，返回验证后的XML报文。

验证通过的报文：

- 7 -

testss10

验证不通过的报文：

Ticket SO6YEWI93093UTYDVXBZ4513== not recognized

客户端解释XML报文对验证通过的报文取节点的值获取到当前登录的用户usessionid。

客户端收到校验通过后的报文，取得用户usessionid，根据usessionid建立本地的用户会话。会话时间可默认为一小时，或根据需要具体配置.客户端再根据usessionid调用平台接口取得当前用户的用户信息。

3.3.3 其它语言配置流程说明

1. 客户端配置需要拦截单点登录请求（如：127.0.0.1:8080/sso/*），但客户端服务器拦截到单点登录请求时重定向到登录页面。用户登录URL地址：:10000/?r=portal/user/login&service=127.0.0.1:8080/ssotest;URL拼写说明：service参数是用户登录后门户重定到客户端的地址，此参数必传不能缺失;此处使用127.0.0.1:8080/ssotest为例子，需根据实际地址修改替换。

2. 用户在门户成功登录认证后，门户会根据service参数地址重定向到客户端（service参数传递的URL地址），并在URL地址后增加ticket参数。如：127.0.0.1:8080/ssotest? ticket=********

3. 客户端获取到ticket值，重定向到用户中心验证ticket有效和合法性， url请求格式为：61.183.248.37:10003/aam/ticketValidate?ticket=

SO6YEWI93093UTYDVXBZ4513==。

URL拼写说明： URL中IP与端口可替换实际的ip与端口，ticket参数是用户中心要求必传不能缺失.客户端请求平台验证ticket，通过验证ticket的有效性，服务端校验通- 8 -

过后，会销毁该一次性ticket,并返回已登录用户名。返回验证后的的XML报文。

验证通过的报文：

testss10

验证不通过的报文：

Ticket SO6YEWI93093UTYDVXBZ4513== not recognized

客户端解释XML报文对验证通过的报文取节点的值获取到当前登录的用户usessionid。

客户端收到校验通过后的报文，取得用户usessionid，根据usessionid建立本地的用户会话。会话时间可默认为一小时，或根据需要具体配置.客户端再根据usessionid调用平台接口取得当前用户的用户信息。

4 接口列表

4.1 API访问鉴权接口

接口名称

获取访问TOKEN

接口方向 接口描述

应用-教育云平台 应用使用访问凭证获取访问令牌

4.2 用户接口

接口名称 接口方向 接口描述

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

应用获取用户基本信息

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

应用获取用户好友列表

应用验证两个用户是否为好友

应用根据班级ID获取班级信息

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

获取当前登录用户应用教育云平台

信息

获取用户基本信息

批量获取用户信息

获取用户好友

验证是否为好友

查询班级信息

查询班级成员信息

- 9 -

应用教育云平台

应用教育云平台

应用教育云平台

应用教育云平台

应用教育云平台

应用教育云平台

4.3 支付接口

接口名称

支付请求

页面跳转同步通知

后台异步通知

接口方向

教育云平台应用

教育云平台应用

接口描述

用户在教育云平台支付完成后，返回至应用支付成功页面

用户在教云平台支付完成后，教育云平台后台通知应用支付结果

应用-教育云平台 应用调用支付页面，请求使用云币支付

4.4 消息接口

接口名称

发送消息

接口方向 接口描述

应用-教育云平台 应用调用接口向用户发送消息

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

5 接口参考

5.1 API访问鉴权接口

5.1.1 获取访问TOKEN

1.接口说明

应用调用平台开放API之前，请求获取访问TOKEN。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

3.参数说明

参数名称

appid

timestamp

keyinfo

是否必须

必选

必选

必选

类型 描述

ip:port/apigateway/getaccesstoken

json

post

true

true

应用平台

String 应用ID

String 时间戳。

String 对APPID、APPKEY、Timestamp进行sha1-hamc运算，加密串为APPID和APPKEY及Timestamp字符串相连,以APPKEY为加密参数

4.返回说明

- 10 -

返回码

000000

999999

5.字段说明

参数名称

token

validtime

是否必须

必选

必选

类型 描述

String token信息

String 有效期，只在有效期内，应用无需重新申请，服务保存token及有效期，有效期内只需做一次验证。

含义说明

操作成功

系统错误

5.2 用户接口

5.2.1 获取当前登录用户信息

1.接口描述

取得当前登录用户的用户信息。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/user/getuserinfo/{usessionid}

--

get

true

true

展现—>AAM

3.参数说明

无

4.返回说明

序号

1

2

字段名

result

desc

约束

必选

可选

类型

string

string

长度 说明

结果

6 000000：成功

301999：usessionid验证失败

250 结果描述

- 11 -

3

4

4.1

4.2

4.3

4.4

4.5

4.6

4.8

4.9

usessionid

ueserinfo

personid

mobnum

email

name

nickname

areacode

gender

birthday

必选

可选

必选

可选

可选

可选

可选

可选

可选

可选

String

string

string

string

string

string

string

string

date

64

60

16

16

32

唯一标识一个登录用户sessionid

用户的统一ID；

手机号码

邮箱

用户姓名

100 昵称

64

1

16

用户归属地区域

性别

0是女，1为男

生日

用户类型:

学生：0

老师：1

家长：2

机构：3

学校：4

学校工作人员：5

机构工作人员：6

4.10 usertype 必选 string 1

4.11

4.12

4.13

address

postcode

可选

可选

string

string

-

256 通讯地址

8

-

邮编

头像LOGO（URL地址）列表

浏览渠道：

1：小；

2：中；

3：大；

userlogolist 可选

4.1 logotype 可选 int 1

4.2

4.14

4.15

logourl

interests

profession

可选

可选

可选

string

string

string

512 头像LOGO（URL地址）

512 兴趣，多个兴趣之间用分号分开

64 职业

0：身份证

1：护照

2：军人证

3：其他

证件号码

4.16 credtype 可选 string 1

4.17

4.18

4.19

idcardno

singature

fnascount

可选

可选

可选

string

string

int

32

140 签名

粉丝数

- 12 -

4.20

4.20.1

4.20.2

teachesubjectlist

subjectid

可选

可选

Json数组

String

String

string

String

string

string

string

string

string

JOSN数组

string

string

50

32

50

32

如登录用户为教师，则返回所教学科，JSON数组

学科id

学科名称

教材id

subjectname 可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

teachmateria4.20.3

lid

4.20.4

4.20.5

4.20.6

4.20.7

4.21

4.22

4.23

4.24

4.25

teachmaterialname

classid

classname

foundtime

classid

classname

classidentity

orgaid

organame

200 教材名称

32

50

4

50

50

2

32

用户所在班级id

班级名称

班级成立年份

用户所在班级名称；当登录用户为学生是会返回该值

班级名称；当登录用户为学生是会返回该值

用户所在班级身份: 1:班主任 2：班长 3：管理员

4: 教师 5：成员 6：教研员，7：教务员，8：信息员

用户所在机构学校id

200 用户所在机构学校名称

用户在机构身份：

1:管理员

4.26 orgaidentity 可选 string 2

2：成员

3：教研员；

4：教务员；

5：信息员，

4.27

tags 可选 string 1000 个人标签

5.2.2 获取用户基本信息

1.接口说明

应用可以获取经过登录认证后用户的基本信息。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/user/userinfobyaccount

json

post

true

true

应用->平台

- 13 -

account:用户账号

3.参数说明

Json请求串：{"account":"Testss10"}

4.返回说明

序号 字段名 约束 类型 长度 说明

结果

000000:：成功

301001：用户不存在

301999：usessionid验证失败

2

2.1

2.2

2.3

2.4

2.5

2.6

2.7

2.8

ueserinfo

personid

mobnum

email

name

nickname

areacode

gender

birthday

可选

必选

可选

可选

可选

可选

可选

可选

可选

string

string

string

string

string

string

string

date

60

16

16

32

100

64

1

16

用户的统一ID；

手机号码

邮箱

用户姓名

昵称

用户归属地区域

性别

0是女，1为男

生日

用户类型

学生：0

2.9 usertype 必选 string 1 老师：1

家长：2

机构：3

通讯地址

邮编

- 头像LOGO（URL地址）列表

浏览渠道：

1：小；

2：中；

3：大；

头像LOGO（URL地址）

1 result 必选 string 6

2.10

2.11

2.12

2.12.1

address

postcode

userlogolist

可选

可选

可选

string

string

-

256

8

logotype 可选 int 1

2.11.2

logourl 可选 string

- 14 -

512

2.13

2.14

2.15

2.16

2.17

interests

profession

singature

tags

account

5.返回结果例子

{

"result": "000000",

"ueserinfo":

可选

可选

可选

可选

可选

string

string

string

string

Stirng

512

64

140

1000

100

兴趣，多个兴趣之间用分号分开

职业

签名

个人标签

账号

{

"personid": "cbdf195ddd1c40efbd3c48ca97c0cbe2",

"mobnum":"130****1479",

"birthday": "",

"gender": "1",

"name": "Testss10",

"usertype": "5",

"credtype": "0 ",

"idcardno":*******************", "fnascount": 0,

"userlogolist": [],

"account": "Testss10"

}

}

5.2.3 批量获取用户信息

1.接口说明

应用获取安装此应用的用户信息。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/users/get

json

post

true

true

应用—>平台

3.参数说明

序号

1

字段名

personids

约束

必选

类型

JOSN数组

长度

说明

多个用户ID

- 15 -

4.返回说明

序号 字段名 约束 类型 长度 说明

结果

000000：成功

301001：用户不存在

301999：usessionid验证失败

2

2.1

2.2

2.3

2.4

2.5

2.6

2.8

2.9

ueserinfo

personid

mobnum

email

name

nickname

areacode

gender

birthday

可选

必选

可选

可选

可选

可选

可选

可选

可选

string

string

string

string

string

string

string

date

1 result 必选 string 6

60

用户的统一ID；

16 手机号码

16 邮箱

32 用户姓名

100 昵称

64 用户归属地区域

1

16

性别

0是女，1为男

生日

用户类型

学生：0

老师：1

家长：2

机构：3

2.10 usertype 必选 string 1

2.11

2.12

2.13

address

postcode

userlogolist

可选

可选

可选

string

string

-

256 通讯地址

8

-

邮编

头像LOGO（URL地址）列表

浏览渠道：

1：小；

2：中；

3：大；

2.13.1 logotype 可选 int 1

2.13.2

2.14

2.15

2.18

2.19

2.20

logourl

interests

profession

singature

tags

account

可选

可选

可选

可选

可选

可选

string

string

string

string

string

Stirng

- 16 -

512 头像LOGO（URL地址）

512

64

兴趣，多个兴趣之间用分号分开

职业

140 签名

1000 个人标签

100 账号

5.返回结果例子

{

"result": "000000",

"ueserinfo":

{

"personid": "cbdf195ddd1c40efbd3c48ca97c0cbe2",

"mobnum":"130****1479",

"birthday": "",

"gender": "1",

"name": "Testss10",

"usertype": "5",

"credtype": "0 ",

"idcardno":*******************", "fnascount": 0,

"userlogolist": [],

"account": "Testss10"

}

}

5.2.4 获取用户好友

1.接口说明

应用可以调用查询用户好友接口，在用户授权的情况下，可以在教育云平台上查询用户的好友信息。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/friend/query/{personid}?start=1&end=10

--

get

true

true

应用平台

personid:用户id

start：查询开始位置

end：查询结束位置

3.参数说明

无

- 17 -

4.返回说明

序号

1

2

3

4

5

5.1

5.2

5.3

5.4

5.5

5.6

字段名

result

start

end

count

list

约束

必选

必选

必选

必选

可选

类型 长度 说明

结果

000000:成功

301001:用户不存在

查询开始位置

查询结束位置

总记录条数

成员信息列表

用户id

用户名

用户姓名

关注时间，我主动关注他的时间

关注时间，他关注我的时间

头像LOGO（URL地址）列表

头像类型：

5.6.1 logotype 可选 int 1

1：小；

2：中；

3：大；

5.6.2

5.返回结果例子

{

“retcode”:”000000”,

logourl 可选 string 512 头像LOGO（URL地址）

string 6

int

int

int

String 32

String 20

string 32

date 32

peronsid 可选

account

name

可选

可选

connecthetime

可选

connectmetime

可选

userlogolist 可选

string 100

- -

“count”:”2”,

“start”:”1”,

“end”:”10”,

“list”: {[

“personid”:”1289301erwopUJYHDW24”,

“areacode”:”510000”

“mobNum“: “138****8000”,

“email”: “*************”,

“name”: “test”

],

[

“personid”:”1289301erwopUJYHDW23”,

“areacode”:”510000”

“mobNum“: “138****8001”,

“email”: “**************”,

- 18 -

“name”: “test2”

]

},

}

5.2.5 验证用户是否为好友

1.接口说明

应用可以调用验证用户是否为好友接口，验证是否为好友。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

3.参数说明

序号 参数名称

1 personid

2 friendid

4.返回说明

返回码

000000

301001

301122

5.字段说明

字段名

result

desc

6.返回结果例子

{

“result”:”000000”,

约束

必选

可选

类型

string

String

说明

返回码

返回消息说明

含义说明

验证成功，为好友关系

用户不存在

好友不存在

是否必须

必须

必选

类型

String

String

描述

用户id

好友的用户id

ip:port/aam/rest/friend/isfriend

json

post

true

true

应用平台

“desc”:”验证成功”

}

5.2.6 查询班级信息

- 19 -

1.接口描述

根据班级ID查询班级信息。

2.请求说明

url

格式

协议

ip:port/aam/rest/classinfo/querybyids

json

post

支持验证方式 ---

是否需要鉴权 true

请求数限制 true

接口方向

3.参数说明

序号

4

字段名

classids

约束

必选

类型

Json数组

长度 说明

-- 班级id的JSON数组，一个或多个

展现—>AAM

4.返回说明

序号

1

2

3

3.1

3.2

3.3

3.4

字段名

result

desc

classinfolist

classid

orgaid

classname

gradeclass

约束

必选

可选

可选

可选

可选

可选

可选

类型

string

string

string

string

string

int

长度

6

50

32

32

20

说明

结果

000000：查询成功

返回描述

班级信息JSON数组

班级ID

所属机构/学校编号

班级名称

班别

相应的数字，代表相应班别，如：1代表1班

年级

1：一年级

3.5 grade 可选

- 20 -

int

2：二年级

3：三年级

4：四年级

5：五年级

6：六年级

7：初一

8：初二

9：初三

10：高一

11：高二

12：高三

3.6

3.10

3.11

3.12

3.12.1

3.12.2

3.13

3.13.1

3.13.2

3.14

3.14.1

3.14.2

3.15

3.15.1

3.15.2

3.16

3.17

3.18

foundtime

created

membercount

classmanager

personid

name

headteacher

personid

name

classmonitor

personid

name

teacherlist

personid

name

classalises

flagpic

classcate

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

string

string

int

string

string

string

string

string

string

string

string

string

String[]

string

string

string

string

string

32

32

32

32

10

32

32

10

32

32

10

32

32

10

50

成立年份

创建时

成员数

班级管理员信息

管理员用户ID

管理员姓名

班主任信息

班主任用户ID

班主任姓名

班长信息

班长用户ID

班长姓名

班级教师信息

教师用户ID

教师姓名

班级别名

256 班级标识图片(URL)

1

班级类型

0：普通班

1：实验班

5.2.7 查询班级成员信息

1.接口描述

查询成员信息。

- 21 -

2.请求说明

url

支持验证方式

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/classmember/{classid}?start=1&end=10

---

json

get

true

true

展现—>AAM

3.参数说明

无

4.返回说明

序号 字段名

1

2

3

4

5

5.1

5.2

5.3

5.4

5.5

5.6

5.7

5.8

5.9

result

start

end

count

ueserinfolist

personid

account

mobnum

email

name

nickname

name

gender

birthday

约束

必选

必选

必选

必选

可选

必选

必选

可选

可选

可选

可选

可选

可选

可选

类型

string

int

int

int

string

string

string

string

string

string

string

string

date

- 22 -

长度

6

60

20

16

16

32

100

16

1

16

说明

结果

000000：成功

301001：用户不存在

查询开始位置

查询结束位置

总记录条数

用户的统一ID；

用户账号

手机号码

邮箱

用户姓名

昵称

姓名

性别

0是女，1为男

生日

5.10

5.11

5.12.1

5.12.2

5.13

usertype

userlogolist

logotype

logourl

classidentity

必选

可选

可选

可选

可选

string

-

int

string

string

1

-

1

512

2

用户类型：学生0，老师1

头像LOGO（URL地址）列表

浏览渠道：1：小；

2：中；3：大；

头像LOGO（URL地址）

用户所在班级身份： 1：班主任 2：班长 3：管理员

4：教师 5：成员

如用户为教师，则返回所教学科，JSON数组

学科id

学科名称

教材id

教材名称

5.14

5.14.1

5.14.2

5.14.3

5.14.4

teachesubjectlist 可选

subjectid

subjectname

teachmaterialid

可选

可选

可选

Json数组 50

String

String

string

String

32

50

32

200 teachmaterialname 可选

5.2.8 用户登录（C/S模式应用）

1.接口说明

C/S系统调用该接口实现用户帐号登录，密码可以是静态密码也可以是动态密码。

2.请求说明

url

支持验证方式

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/account/login

---

json

post

true

true

应用—>AAM

3.参数说明

序号 字段名

1

2

account

password

约束 类型 长度

128

32

说明

注册账号。

静态密码或动态密码；静态密码加密方式：MD5加密后字母字符为大写的字符串，再经过RC4加密(加密的密钥user_sercretkey)；密码经过加密后再传输； 动态密码登录时，为明文。当采用静态密码或动态密码方式认证时，必选。

必选

string

必选

string

- 23 -

3 passwdtype

可选

string 4

密码类型：默认是0

0：静态密码

1：动态密码

登陆来源

99：其他

4

portaltype

必选

string 1

4.返回说明

序号

1

2

3

4

5

5.1

5.2

5.3

5.4

5.5

5.6

5.7

5.8

5.9

字段名

result

desc

tgcticke

usessionid

ueserinfo

personid

mobnum

email

name

nickname

areacode

name

gender

birthday

约束

必选

可选

可选

可选

可选

必选

可选

可选

可选

可选

可选

可选

可选

可选

类型

string

string

String

String

string

string

string

string

string

string

string

string

date

60

16

16

32

长度

6

说明

订购结果

000000：成功

301001：用户不存在

250 结果描述

64

64

永久Ticket，唯一标识一个登录用户

唯一标识一个登录用户sessionid

用户的统一ID；

手机号码

邮箱

用户姓名

100 昵称

64

16

1

16

用户归属地区域

姓名

性别0是女，1为男

生日

用户类型：

学生：0

老师：1

家长：2

机构：3

学校：4

学校工作人员：5

机构工作人员：6

5.10 usertype 必选 string 1

- 24 -

5.11

5.12

5.13

5.13.1

5.13.2

5.14

5.15

5.16

5.17

5.18

5.19

5.20

5.20.1

5.20.2

5.20.3

5.20.4

5.20.5

5.20.6

5.20.7

5.21

5.22

address

postcode

userlogolist

logotype

logourl

interests

profession

credtype

idcardno

singature

fnascount

teachesubjectlist

subjectid

subjectname

teachmaterialid

teachmaterialname

classid

classname

foundtime

classid

classname

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

string

string

-

int

string

string

string

string

string

string

int

Json数组

String

String

string

String

string

string

string

string

string

256 通讯地址

8

-

1

邮编

头像LOGO（URL地址）列表

浏览渠道：1：小；2：中；

3：大；

512 头像LOGO（URL地址）

512

64

1

32

兴趣，多个兴趣之间用分号分开

职业

0：身份证1：护照

2：军人证3：其他

证件号码

140 签名

粉丝数

50

32

50

32

如登录用户为教师，则返回所教学科，JSON数组

学科id

学科名称

教材id

200 教材名称

32

50

4

50

50

用户所在班级id

班级名称

班级成立年份

用户所在班级名称

班级名称

用户所在班级身份：

1：班主任

2：班长

3：管理员

5.23 classidentity 可选 JOSN数组 2 4：教师

5：成员

6：教研员

7：教务员

8：信息员

用户所在机构学校id 5.24 orgaid 可选

- 25 -

string 32

5.25 organame 可选 string 200 用户所在机构学校名称

用户在机构身份：

1：管理员

5.26 orgaidentity 可选 string 2

2：成员

3：教研员

4：教务员

5：信息员

5.27

5.28

tags

areacode

可选

可选

string

string

1000 个人标签

8 所在地区编码

5.2.9 查询班级列表

1.接口描述

根据机构ID或班级ID查询班级列表。

2.请求说明

url

支持验证方式

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/classinfo/query

---

json

post

true

true

应用—>AAM

3.参数说明

序号

1

2

3

4

字段名

orgaid

start

end

classids

约束

可选

可选

可选

可选

类型

string

string

string

String[]

长度

64

20

30

20

个

说明

可为机构ID、学校ID

查询开始记录下标

查询结束记录下标

班级id的JSON数组，一个或多

- 26 -

4.返回说明

序号

1

2

3

4

5

5.1

5.2

5.3

5.4

字段名

result

start

end

count

classinfolist

classid

orgaid

classname

gradeclass

约束

必选

必选

必选

必选

可选

可选

可选

可选

可选

类型

string

String

String

String

string

string

string

int

32

32

20

长度

6

8

8

8

说明

结果

000000：成功

查询开始位置

查询结束位置

总记录条数

班级信息列表

班级ID

所属机构/学校编号

班级名称

班别

相应的数字，代表相应班别，如：1代表1班

年级

1：一年级

2：二年级

3：三年级

4：四年级

5.5

grade

可选 int

5：五年级

6：六年级

7：初一

8：初二

9：初三

10：高一

11：高二

5.6

5.7

foundtime

jointype

可选

可选

string

string

32

1

12：高三

成立年份

加入方式

1：申请加入；2：邀请加入； 3：输入验证码加入

加入验证码

邀请权限

1：成员可邀请其他人加入

- 27 -

5.8 joinvalinum

可选

string

20

5.9

invitepermi

可选

string

1

2：只有班主任或班长邀请加入

5.10

5.11

5.12

5.12.1

5.12.2

5.13

5.13.1

5.13.2

5.14

5.14.1

5.14.2

5.15

5.15.1

5.15.2

5.16

5.17

5.18

created

membercount

classmanager

personid

name

headteacher

personid

name

classmonitor

personid

name

teacherlist

personid

name

classalises

flagpic

classcate

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

可选

string

int

string

string

string

string

string

string

string

string

string

String[]

string

string

string

string

string

32

32

10

32

32

10

32

32

10

32

32

10

50

256

1

32

创建时间

成员数

管理员，用户ID

用户ID

姓名

班主任，用户ID

用户ID

姓名

班长，用户id

用户ID

姓名

班级教师，用户ID数组

用户ID

姓名

班级别名

班级标识图片(URL)

班级类型

0：普通班

1：实验班

5.2.10

查询班级学生

- 28 -

1.接口说明

查询学校班级学生。

2.请求说明

url

支持验证方式

格式

协议

是否需要鉴权

请求数限制

接口方向

ip:port/aam/rest/classinfo/querystudent

--

json

post

true

true

应用—>AAM

3.参数说明

序号

1

2

3

4

字段名

schoolid

classid

start

end

约束

可选

可选

必选

必选

类型

string

string

int

int

长度

32

32

10

10

说明

学校ID，班级ID可选此项必填

班级ID，学校ID可选此项必填

开始数

结束数

4.返回说明

序号

1

2

3

4

5

4

4.1

4.2

4.3

4.4

字段名

result

desc

count

start

end

userlist

personid

name

mobnum

email

约束

必选

可选

可选

可选

可选

可选

可选

可选

可选

可选

类型

string

string

int

int

int

Json数组

String

string

string

string

长度

6

50

20

32

20

结果

000000：成功

返回消息描述

用户数

查询起始数

结束数

成员，json数组

用户ID

用户姓名

手机号码

说明

100 邮箱

5.响应示例

{

- 29 -

“result”: “000000”,

“count”: “2”,

“userlist”: [{

“personid”:”123fgser4563sdf”,

“mobnum “: “138****8000”,

“email”: “************”,

“name”: “测试1”

},

{

“personid”:”123fgser4563sdf”,

“mobnum “: “138****8000”,

“email”: “************”,

“name”: “测试2”

}

]

}

5.3 支付接口

5.3.1 支付请求

1.接口说明

由合作伙伴提交订单信息调用订单系统接口，订单系统处理后返回处理信息。

2.请求说明

url

协议

是否需要鉴权

请求数限制

接口方向

URL参数说明：

序号

1

2

字段名

callbackUrl

notifyUrl

约束

必选

必选

类型

String

String

长度

100

100

个URL

后台通知交易结果时返回到这个URL

说明

页面通知交易结果时将返回到这/paymentservice/paymentrequest

get

true

true

应用平台

- 30 -

3

4

providerId

requestId

必选

必选

String

String

50

50

合作伙伴ID

合作伙伴请求的交易流水号，需要唯一

获得hmac的方法见签名算法，参数顺序按照表格中从上到下的顺序，但不包括本参数

订单金额，扣取云币值

合作伙伴发起请求的时间(年年年年月月日日)

合作伙伴系统订单号

合作伙伴发起请求的会计日期(年年年年月月日日)

对产品的描述

所购买产品的编号

所购买产品的名称

所购买产品的数量

用户帐号

应用ID

5

6

7

8

9

10

11

12

13

14

15

hmac

amount

orderDate

orderId

merAcDate

productDesc

productId

productName

productNum

usercode

appid

必选

必选

必选

必选

可选

必选

必选

必选

可选

必选

必选

String

number

String

String

String

String

String

String

Number

String

String

64

32

10

8

50

8

256

50

50

3.参数说明

无

4.返回说明

返回结果有页面跳转同步通知（3.1.2）和后台异步通知（3.1.3）两种方式

5.3.2 页面跳转同步通知

1.接口说明

用户在平台支付完成以后，会将支付的结果数据，通过系统程序控制客户端页面以自动跳转的方式通知给合作伙伴，这些处理结果数据就是页面跳转同步通知参数；

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

- 31 -

/paymentservice/paymentrequest

json

get

true

true

应用平台

3.参数说明

序号 字段名

1

2

3

4

5

6

7

8

9

10

11

12

providerid

payNo

returnCode

message

amount

version

orderid

payDate

reserved1

reserved2

reserved3

status

约束

必选

必选

必选

必选

必选

必选

必选

必选

可选

可选

可选

必选

类型

String

String

String

String

number

String

String

String

String

String

String

String

长度

50

100

50

50

10

8

50

20

250

250

250

10

提供商ID

平台返回的交易流水号

返回码

返回码提示信息

订单金额，以分为单位, 如1元表示为100

版本号，现为1.0.0

提供商订单号

用户完成支付的时间

保留字段1

保留字段2

保留字段3

支付结果

成功：success

失败：fail

提供商发起请求的日期：

年年年年月月日日

以上请求参数生成的签名串，获得hmac的方法见签14 hmac 必选 名算法，参数顺序按照表格中从上到下的顺序，但不包括证书公钥和本参数

4.返回说明

无

- 32 -

说明

13 orderDate 必选 String 10

5.3.3 后台异步通知

1.接口说明

用户在平台支付完成以后，会将支付的结果数据通过服务器以主动通知的方式通知给供应商系统，供应商系统接收到结果数据之后，处理完自己的业务逻辑，处理成功后返回给平台一个处理结果SUCCESS。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

3.参数说明

序号

1

2

3

4

5

6

字段名

providerid

payNo

returnCode

message

amount

version

约束

必选

必选

必选

必选

必选

必选

类型

String

String

String

String

number

String

长度

50

100

50

50

10

8

提供商ID

平台返回的交易流水号

返回码

返回码提示信息

订单金额，以分为单位， 如1元表示为100

版本号,现为1.0.0

说明

/paymentservice/payment

json

post

true

true

平台应用

- 33 -

7

8

9

10

11

12

orderid

payDate

reserved1

reserved2

reserved3

status

必选

必选

可选

可选

可选

必选

String

String

String

String

String

String

50

20

250

250

250

10

提供商订单号

用户完成支付的时间

保留字段1

保留字段2

保留字段3

支付结果

成功：success

失败：fail

提供商发起请求的日期：

年年年年月月日日

以上请求参数生成的签名串，获得hmac的方法见签13 orderDate 必选 String 10

14 hmac 必选 名算法，参数顺序按照表格中从上到下的顺序，但不包括证书公钥和本参数。

4.返回说明

序号

1

字段名

result

约束

必选

类型

String

长度

10

说明

合作伙伴处理结果

success代表成功。

fail代表失败。

5.3.4 订购鉴权

1.接口说明

应用请求平台进行订购鉴权，平台向应用返回鉴权结果。应用根据鉴权结果进行应用侧逻辑处理。

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

3.参数说明

- 34 -

/ruif/subscriptionvalidate

json

post

true

true

平台应用

序号

1

2

3

字段名

userid

appid

productid

约束

必选

必选

必选

类型

String

String

String

长度

32

32

32

用户ID

应用ID

产品ID

说明

4.返回说明

序号

1

字段名

result

约束

必选

类型

String

长度

10

说明

合作伙伴处理结果

000000：订购关系正常

500001：不存在订购关系

5.4 消息接口

5.4.1 发送消息

1.接口说明

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

2.请求说明

url

格式

协议

是否需要鉴权

请求数限制

接口方向

3.参数说明

序号 字段名 约束

必选

可选

必选

可选

必选

类型

String

String

String

String

String

- 35 -

ip:port/eduServer2/api/mc/post

--

post

true

true

应用—>平台

长度

50

50

500

100

10

应用标识

说明

1 appid

2 sid

3 c

3 titile

4 type

发送消息人会话标识

当以用户身份发送消息时，此参数必选

消息内容

消息标题

remind/znx

remind应用消息

znx私信

4 toFans

5 toUid

可选

可选

String

50

发送给关注我的人 true

发送给指定的人

注：toFans与toUid必须有一项是有值项。

4.返回说明

序号

1

字段名

retCode

约束

必选

类型

String

长度

10

说明

结果码

0：成功

2：服务器内部错误

- 36 -