top
关闭

开发者登录

Oauth认证API

主要使用场景:需要使用慧教云平台用户登录第三方应用系统,并获取保存在平台的用户信息时,由用户授权使用

1、获取Oauth令牌

第三方平台与慧教云平台互联互通,获取Oauth认证令牌后,可以通过单点登录跳转到慧教云平台。

前置条件

a、获取接口访问凭证:accessToken。
b、获取Oauth临时授权码。

请求说明

url http://opengate.huijiaoyun.com/oauth/getAuthToken?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

oauthCode

必选

String

64.0

临时授权码:第三方应用通过Oauth页面登录后可以获取

返回说明

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

1

retDesc

必选

String

64.0

返回消息描述

2

retCode

必选

String

100.0

结果
000000:成功

3

oauthToken

必选

String

64.0

授权令牌,只有result为000000时,才会返回访问

4

expiry

必选

Long

64.0

有效期,只有result为000000时,才会返回访问

示例

							请求报文:
{
    "oauthCode": "0b37d86ec2796085eb4******"
}
应答报文:
{
    "retCode": "000000",
    "retDesc": "success",
    "expiry": "1452129927155",
    "oauthToken": "526ce28703b0068dce******"
}          
						

2、注销Oauth令牌

用户注销后可让当前令牌失效。

前置条件

a、获取接口访问凭证:accessToken b、获取Oauth认证令牌。

请求说明

url http://opengate.huijiaoyun.com/oauth/cancelAuthToken?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

oauthToken

必选

String

64.0

Oauth凭证

返回说明

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

1

retCode

必选

String

6.0

结果
000000:成功

2

retDesc

必选

String

100.0

返回描述

示例

							请求报文:
{
    "oauthToken":"526ce28703b0068******"
}
应答报文:
{
    "retDesc":"成功",
    "retCode":"000000"
}            
						

3、获取Oauth访问ticket

第三方平台通过oauth授权登录绑定后,访问教育云个人空间需要用到临时访问ticket

前置条件

请求说明

url http://opengate.huijiaoyun.com/oauth/getAccessTicket?accessToken=ACCESS_TOKEN
请求方式 get
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

返回说明

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

1

retCode

必选

String

6

结果 000000:成功

2

retDesc

必选

String

100

返回描述

3

accessTicket

必选

String

64

临时访问ticket,使用后失效

示例

							{
  "retDesc":"成功",
  "retCode":"000000",
 "accessTicket" :"******"
}
						
关闭

扫码登录更安全

手机扫码,安全登录

二维码已失效 请点击刷新
请打开家校帮扫一扫登录

手机扫码,安全登录

扫描成功!

请在手机上确认登录

取消二维码登录

参数说明

请求参数消息体-文本类
序号 字段名 约束 类型 长度 说明

1

msgType

必选

String

10

消息类型,此时固定为:text

1.1

text

必选

Json

-

text消息体

1.1.1

content

必选

String

消息内容

示例

{
	"msgtype": "text",
	"text": {
		"content": "zhxy msg text test 12"
	}
}
											

参数说明

请求参数消息体-link类
序号 字段名 约束 类型 长度 说明

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"
	}
}
											

参数说明

请求参数消息体-oa类
序号 字段名 约束 类型 长度 说明

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

消息体的关键字对应的值