top
关闭

开发者登录

主要使用场景:

1、获取接口访问令牌

开发者调用平台接口的第一步,访问令牌是开发者使用接口的凭证,通过访问令牌开发者可以使用自身权限下的各种接口。

前置条件

请求说明

url http://opengate.nmgjyyun.cn/apigateway/getAccessToken
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

appId

必选

Body(form)

String

64

应用ID

2

timeStamp

必选

Body(form)

String

-

时间戳

3

keyInfo

必选

Body(form)

String

-

对APPID、APPKEY、Timestamp进行sha1-hamc运算,加密串为APPID和APPKEY及Timestamp字符串相连,以APPKEY为加密参数; Php使用的签名函数:hash_hmac,hash_algos参数值为sha1,具体的工具类请开发文档中下载SDK。

4

platformCode

可选

Body(form)

String

10

平台编码,默认慧教云平台,编码:888888,支持多平台接口调用

返回说明

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

1

retCode

必选

String

10

返回码

2

retDesc

必选

String

100

返回码描述

3

tokenInfo

必选

Json对象

-

返回的token对象信息

3.1

validTime

必选

String

32

返回token有效期

3.2

platformCode

可选

String

10

所属平台编码

3.3

account

必选

String

64

用户帐号

3.4

appId

必选

String

64

应用ID

3.5

accessToken

必选

String

64

访问令牌

3.6

appName

必选

String

64

应用名称

示例

							请求报文:
{
	"appId":"5736915E311EA64DEA******",
	"keyInfo":"E4AA972000C1262169743C******",
	"timeStamp":"1458282******"
}
应答报文:
{
    "tokenInfo": {
        "validTime": "14670914******",
        "platformCode": ,
        "userId": "AP93******",
        "appId": "5736915E311EA64DEA******",
        "accessToken": "77b117c4069e4f74b2434******",
        "appName": "******"
    },
    "retCode": "000000",
    "retDesc": "获取Token成功。"
}
						

参数说明

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

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

消息体的关键字对应的值