签名说明

下文中我们将调用开放接口的开发者称之为：使用者，将提供开放接口的开发者称之为：提供者。
签名验证，提供者，要对外提供开放接口时，调用基础服务验证请求是否有权限。
应用权限分为，应用权限，用户应用权限，用户应用权限是需要用户在登录时授权的权限。

提供者，只需要在使用者传来的数据中加入下面数据，提供者需要调用/verify_sign接口验证签名

myAppId：是提供者在开放平台申请的，
authorityCode：权限code,该接口的权限标识，是提供者在开放平台创建的应用权限或用户应用权限code
userId：用户id，验证用户权限时必填，不验证用户权限可以不填。

使用者，在使用提供者提供的接口的时候需要传递:

signType：签名类型
appId：应用id，使用者在开放平台申请的。
sign：签名
signData：签名的数据

签名类型详解

md5：md5签名，使用BASE64编码signData。
aes：aes签名，使用BASE64编码signData。
aes_md5：aes和md5结合签名，signData使用aes加密，签名使用md5，适用于安全级别比较高的调用。
在使用aes_md5签名方式的时候开放平台会返回签名数据给提供者，由提供者使用自己的appSecret使用aes进行解密获取数据

签名规则

签名的字段按26个字母的顺序排序，
然后转换成json拼接上appSecret秘钥
使用md5/aes加密字符串
签名必须是字符串

不需要签名的开放接口

单点登录访问

描述

单点登录访问，直接访问链接登录

接口

/oauth/login

请求方法

GET

入参

字段	必填	类型	描述
appId	是	query	应用ID
redirectUri	是	query	登录成功重定向地址
state	是	query	客户端的状态值防止CSRF攻击

返回参数【集合】

字段	类型	描述
code	String	登录成功授权code,重定向地址参数，使用`code`访问`/open/token`接口获取用户token信息

签名验证

描述

签名验证，用于验证签名是否有效

接口

/verify_sign

请求方法

GET

入参

字段	必填	类型	描述
signType	是	query	签名类型
appId	是	query	应用id，使用者应用id
sign	是	query	签名
signData	是	query	签名的数据
myAppId	是	query	我的应用id，申请验证者的应用id
authorityCode	否	query	权限code
userId	否	query	用户id

返回参数【集合】

字段	类型	描述
userId	String	用户id
signData	String	签名的数据

需要签名的开放接口

获取token信息

描述

获取token信息，登录后使用code来换取token信息

接口

/open/token

请求方法

GET

入参

字段	必填	类型	描述
code	是	query	授权码

返回参数【对象】

字段	类型	描述
appId	String	登录的是那个应用
accessToken	String	用户token
refreshToken	String	刷新token
validTime	Long	有效期
updateTime	Date	更新时间
account	String	用户账号
userId	String	用户id
authorityCodes	List	用户权限code集合
userIds	List	用户组下的用户id集合
groupAuthorityCodes	List	用户组权限code集合

获取信息集合

描述

获取信息集合，返回的数据皆为有效数据

接口

/open/info_list

请求方法

GET

入参

字段	必填	类型	描述
type	否	query	信息类型：0：客户端信息，1：后台信息，为null查询全部

返回参数【集合】

字段	类型	描述
id	String	主键id
key	String	信息key
value	String	信息值
describe	String	信息描述
appId	String	应用id
type	String	应用信息类型
status	String	状态，对应字典表的
createTime	Date	创建时间
updateTime	Date	更新时间

获取字典集合

描述

获取字典集合，返回的数据皆为有效数据

接口

/open/dict_list

请求方法

GET

入参

字段	必填	类型	描述
type	否	query	字典类型，为null查询全部

返回参数【集合】

字段	类型	描述
id	String	主键id
name	String	字典名称
value	String	字典值
type	String	字典类型
appId	String	应用主键id
status	String	状态，对应字典表的status
createTime	Date	创建时间
updateTime	Date	更新时间

获取菜单集合

描述

获取菜单集合，返回的数据皆为有效数据

接口

/open/menu_list

请求方法

GET

入参

字段	必填	类型	描述
无	无	无	无

返回参数【集合】

字段	类型	描述
id	String	主键
name	String	菜单名称
url	String	跳转地址
code	String	菜单标识，对应权限表的code
icon	String	图标
parentId	String	上级菜单关联id
seq	Integer	排序
appId	String	应用主键id
type	String	菜单类型
status	String	状态，对应字典表的status
createTime	Date	创建时间
updateTime	Date	更新时间

删除token信息

描述

删除token信息，删除服务器的token信息

接口

/open/token/{token}

请求方法

DELETE

入参

字段	必填	类型	描述
token	是	path	token

返回参数【无】

字段	类型	描述
无	无	无

更新token信息

描述

更新token信息，并且获取新的token

接口

/open/token/{refreshToken}

请求方法

PUT

入参

字段	必填	类型	描述
refreshToken	是	path	刷新token

返回参数【对象】

字段	类型	描述
accessToken	String	用户token
refreshToken	String	刷新token
validTime	Long	有效期
updateTime	Date	更新时间
userId	String	用户id
userIds	List	用户组下的用户id集合
appId	String	登录的是那个应用
account	String	用户账号
authorityCodes	List	权限code集合

获取用户集合

描述

获取用户集合，获取的是用户基础信息，应用的用户集合
该接口处于计划阶段数据还不全面

接口

/open/user_list

请求方法

GET

入参

字段	必填	类型	描述
appId	是	query	应用ID
appSecret	是	query	应用秘钥

返回参数【集合】

字段	类型	描述
id	String	用户主键
portrait	String	头像
nickName	String	昵称
explain	String	个人说明
account	String	账号
email	String	邮箱

获取用户基础信息

描述

获取用户基础信息

接口

/open/user/{userId}

请求方法

GET

入参

字段	必填	类型	描述
userId	是	path	用户id

返回参数【对象】

字段	类型	描述
id	String	用户主键
account	String	账号
email	String	邮箱
phone	String	手机号
failRecord	Integer	登录失败次数
initialAdmin	String	初始化管理员：对应字典表的whether：0：是，1：否
status	String	用户状态：对应字典表的userStatus，0：正常，1：锁定
createTime	Date	创建时间
updateTime	Date	更新时间

修改密码

描述

修改密码

接口

/open/user/{userId}/password

请求方法

PUT

入参

字段	必填	类型	描述
userId	是	path	用户id
password	是	body	用户id，没有密码，设置密码时可以不填
newPassword	是	body	用户id

返回参数【对象】

字段	类型	描述
id	String	用户主键
account	String	账号
email	String	邮箱
phone	String	手机号
failRecord	Integer	登录失败次数
initialAdmin	String	初始化管理员：对应字典表的whether：0：是，1：否
status	String	用户状态：对应字典表的userStatus，0：正常，1：锁定
createTime	Date	创建时间
updateTime	Date	更新时间

获取区域集合

描述

获取区域集合

接口

/open/area_list

请求方法

GET

入参

字段	必填	类型	描述
parentNode	是	query	父级节点

返回参数【集合】

字段	类型	描述
id	String	主键id
name	String	区域名称
code	String	区域code
seq	String	排序
node	String	节点
parentNode	String	父级节点
status	String	区域状态，对应字典表的effectStatus，0：有效，1：无效
createTime	Date	创建时间
updateTime	Date	更新时间

修改用户信息

描述

修改用户信息

接口

/open/user_info/{userId}

请求方法

GET

入参

字段	必填	类型	描述
userId	是	path	用户id
nickName	是	body	昵称
portrait	是	body	头像
explain	是	body	个人说明
sex	是	body	性别：对应字典表的sex：0：女，1：男
birthday	是	body	生日
idCard	是	body	身份证
country	是	body	国家
province	是	body	省
city	是	body	市

返回参数【对象】

字段	类型	描述
id	String	用户主键
userId	String	用户id
nickName	String	昵称
portrait	String	头像
explain	String	个人说明
sex	String	性别：对应字典表的sex：0：女，1：男
birthday	Date	生日
idCard	String	身份证
country	String	国家
province	String	省
city	String	市
createTime	Date	创建时间不能为空
updateTime	Date	更新时间不能为空

获取用户信息

描述

获取用户信息

接口

/open/user_info/{userId}

请求方法

GET

入参

字段	必填	类型	描述
userId	是	path	用户id

返回参数【对象】

字段	类型	描述
id	String	用户主键
userId	String	用户id
nickName	String	昵称
portrait	String	头像
explain	String	个人说明
sex	String	性别：对应字典表的sex：0：女，1：男
birthday	Date	生日
idCard	String	身份证
country	String	国家
province	String	省
city	String	市
createTime	Date	创建时间不能为空
updateTime	Date	更新时间不能为空

发送验证码

描述

发送验证码

接口

/open/send_captcha

请求方法

POST

入参

字段	必填	类型	描述
accountType	是	body	账号类型
account	是	body	账号
captchaType	是	body	验证码类型，register：注册，forget：忘记密码

返回参数【无】

字段	类型	描述
无	无	无

修改用户邮箱

描述

修改用户邮箱

接口

/open/send_captcha

请求方法

POST

入参

字段	必填	类型	描述
userId	是	path	用户id
mail	是	body	账号
captcha	是	body	验证码

返回参数【无】

字段	类型	描述
无	无	无

修改用户手机号

描述

修改用户手机号

接口

/open/user/{userId}/phone

请求方法

POST

入参

字段	必填	类型	描述
userId	是	path	用户id
phone	是	body	手机号
captcha	是	body	验证码

返回参数【无】

字段	类型	描述
无	无	无

获取用户信息集合

描述

获取用户信息集合

接口

/open/user_info_list

请求方法

POST

入参

字段	必填	类型	描述
无	无	无	无

返回参数【集合】

字段	类型	描述
id	String	用户主键
userId	String	用户id
nickName	String	昵称
portrait	String	头像
explain	String	个人说明
sex	String	性别：对应字典表的sex：0：女，1：男
birthday	Date	生日
idCard	String	身份证
country	String	国家
province	String	省
city	String	市
createTime	Date	创建时间不能为空
updateTime	Date	更新时间不能为空

获取已删除用户Id集合

描述

获取已删除用户Id集合，获取的是当前应用的数据

接口

/open/deleted_user_list

请求方法

POST

入参

字段	必填	类型	描述
无	无	无	无

返回参数【集合】

字段	类型	描述
id	String	用户主键，返回的是一个String集合

注销账户

描述

注销账户，删除用户

接口

/open/user/{userId}

请求方法

POST

入参

字段	必填	类型	描述
userId	是	path	手机号
captcha	是	query	验证码

返回参数【集合】

字段	类型	描述
id	String	用户主键
account	String	账号
email	String	邮箱
phone	String	手机号
failRecord	Integer	登录失败次数
initialAdmin	String	初始化管理员：对应字典表的whether：0：是，1：否
status	String	用户状态：对应字典表的userStatus，0：正常，1：锁定
createTime	Date	创建时间
updateTime	Date	更新时间

发送消息

描述

发送消息

接口

/open/send_message

请求方法

POST

入参

字段	必填	类型	描述
code	是	body	消息标识
account	是	body	接收者账号
data	是	body	消息数据，map格式

返回参数【无】

字段	类型	描述
无	无	无

获取外网ip地址

描述

获取外网ip地址

接口

/open/outer/ip

请求方法

GET

入参

字段	必填	类型	描述
无	无	无	无

返回参数【ip地址】

字段	类型	描述
无	无	无

【星云管理平台】开放接口文档

签名说明

不需要签名的开放接口

单点登录访问

签名验证

需要签名的开放接口

获取token信息

获取信息集合

获取字典集合

获取菜单集合

删除token信息

更新token信息

获取用户集合

获取用户基础信息

修改密码

获取区域集合

修改用户信息

获取用户信息

发送验证码

修改用户邮箱

修改用户手机号

获取用户信息集合

获取已删除用户Id集合

注销账户

发送消息

获取外网ip地址

文章评论