消息对外API
信息保存对外api描述SID向应用提供的标准接口,以便外部应用调用。标准接口如下:
一、获取access_token
获取access_token是调用SourceID业务接口的第一步,相当于创建了一个登录凭证,相关业务API接口都需要依赖于access_token来鉴权调用者身份。因此开发者,在使用业务接口前,要明确access_token的颁发来源,使用正确的access_token。 token闲置两个小时会失效
请求⽅式: GET(HTTPS或HTTP)
请求地址: http://sso.xxx.cn/oauth2.0/accessToken?grant_type=client_credentials&client_id=xxx&client_secret=xxx
注:https方式类似。
请求参数:
无
参数说明:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
grant_type | String | 是 | 客户端模式,这里固定为client_credentials |
client_id | String | 是 | 应用id |
client_secret | String | 是 | 应用秘钥 |
client_secret | String | 否 | 权限列表,以空格分隔,空为默认 |
返回结果:
{
"access_token": "AT-1-IWyhZhU1hKKvWPddAJpdHRN2ECu08Ypo",
"token_type": "bearer",
"expires_in": 28800
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
access_token | String | 访问令牌 |
token_type | String | 令牌类型 |
expires_in | Long | 令牌有效期 单位秒 |
二、保存应用消息接口
当需要在微门户上展示消息时,通过该接口告知消息的相关内容以便做后续的展示
请求⽅式: POST(HTTPS或HTTP)
请求地址: http://self.xxx.cn/api-center/third-party-message/save
注:https方式类似。
设置请求头: Authorization: Bearer {access_token}
请求参数:
{
"userId" : "65310141",
"clientId": "5ed78ac5f846ae00015e015e",
"url": "http://***.com",
"title": "绩效系统待审批消息",
"content":"您当前尚有7条待审批消息",
"amount": 7,
"time": 1699508804000
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
userId | String | 用户学工号,消息要展示给哪个用户的学工号 |
clientId | String | 客户端id,在我们系统中注册后,得到的clientId,用来识别消息来源 |
url | String | 跳转url |
title | String | 标题, eg: 绩效系统审批待处理 |
content | String | 消息内容:eg:您当前尚有X条待审批消息 |
amount | Integer | 待处理消息数量 |
time | long | 时间, 时间戳格式,eg: 1699508804000 |
返回结果:
{
"code": 200,
"message": "OK",
"data": null
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态code |
message | String | 返回状态消息 |
data | 自定义对象 | 返回值为身份标签信息列表 |
接口调用失败请查看开发指南-Token与Api调用失败须知