主要使用场景:
获取门户空间公共HTML部分信息,使得应用能够方便的使用门户或者空间,例如头部和底部页面HTML代码。
1、获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/space/common/publicHtml?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
method |
必选 |
Body(json) |
String |
32 |
commonHTML |
2 |
params |
必选 |
Body(json) |
JSON[] |
- |
POST 参数JSON[] |
3 |
portaltype |
可选 |
Body(json) |
Int |
1 |
门户类型 0:web 1:wap 2:客户端 |
4 |
islogin |
可选 |
Body(json) |
Int |
1 |
用户登录状态,可以通过该参数强制获取非登录状态的公共html代码 0:未登录 1:已登录 |
5 |
usessionid |
可选 |
Body(json) |
String |
255.0 |
单点登录成功后通过平台用户中心(AAM)子系统接口获取到的用户会话参数,展现子系统通过该参数判定用户是否登录,判定通过则返回已经登录的公共HTML代码,判定失败则返回用户未登录的数据代码 |
6 |
areacode |
可选 |
Body(json) |
String |
6.0 |
虚拟门户使用行政区域编码,默认为国家 国家:100000 湖北:420000 武汉:420100 东阳:330783 |
7 |
type |
必选 |
Body(json) |
String |
20.0 |
公共HTML代码部分类型 header:门户页眉 footer:门户页脚 zoneHeader:空间页眉 zoneFooter:空间页脚 |
8 |
version |
可选 |
Body(json) |
String |
20.0 |
WAP版本 1:简版 2:3G版 3:触屏版 |
9 |
resourceid |
可选 |
Body(json) |
String |
20.0 |
应用或资源接入编号,为了门户或空间应用统一面包屑,应用介绍,入口统计做依据 |
10 |
logoarea |
可选 |
Body(json) |
String |
10.0 |
控制logo区域一行是否显示,默认显示,0不显示,非0显示 |
11 |
spaceuid |
可选 |
Body(json) |
String |
32.0 |
被访问用户空间的用户id |
12 |
headtype |
可选 |
Body(json) |
String |
2.0 |
空间头类型 1:学校 2:班级 3:访客 |
13 |
scid |
可选 |
Body(json) |
String |
32.0 |
学校id或班级id 与headtype结合使用 |
14 |
logo |
可选 |
Body(json) |
String |
1.0 |
取门户头时logo头像,默认0是武汉1是一师一课 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6.0 |
返回码 |
2 |
retDesc |
必选 |
String |
- |
返回码描述 |
3 |
result |
必选 |
JSON |
- |
返回的参数 |
3.1 |
commonContent |
可选 |
String |
- |
对应的公共页面Html内容 |
3.2 |
platformCode |
可选 |
String |
- |
平台编码 |
请求报文: { "method":"commonHTML", "params":{ "islogin":"0", "areacode":"888888", "type":"header", "logoArea":"0" } } 应答报文: { "retCode": "000000", "retDesc": "请求成功!", "result": { "commonContent": "HTML页面", "platformCode": "888888" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |