菜单

1.认证类

下载

认证类

获取token

  • 接口描述:传入用户名、密码进行登录验证,验证通过则返回token令牌,nvisual内登录时会调用此接口来获取token,nvisual内几乎每个接口都需要使用此接口生成的令牌做Authorization的Bearer Token验证。

  • URL地址:http://ip:port /wapi/v1/authenticate

  • 访问方法::Post

  • 请求参数:

    Body参数

参数名 类型 示例值 必填 说明
username String admin 用户名
password String adminqqq 密码
noexp Bool true 是否获取不过期token
  • 需注意,正常获取的token的过期时间由java配置文件内配置决定,默认10分钟过期,过期后需要重新获取token;

    如果此接口传参noexp为true则获取不过期token。

    回参内的access_token即为token。

  • 响应示例:

成功示例:

{

"code": 200,

"data": {

"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJsdWNpIiwibmFtZSI6Imx1Y2kiLCJleHAiOjI2NzM0ODM5MDcsImlhdCI6MTcyNzQwMzkwN30.2vtMhwhbfDmCVM23nfVWqqlK7g0CU_QoKW_NoVihxWhnm5cIYuJUMQSeCu-3_9jJvM-IJ8g6ZNidlfzPm4k4kw",

"refresh_token": "eyJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEYXRlIjoiMjAyNC0wOS0yN1QwMzowNTowNy4wMzBaIn0.zk4T1sUSypwCe2TrDGyAB1FAKp4ncelOkC6_CLctZ10",

"expires": "2025-09-27T10:25:07.035",

"authority": "Admin",

"organization": null,

"language": 1,

"share": false,

"token_type": "bearer",

"issued": "2024-09-27T10:25:07.034",

"user": "luci",

"userId": 94000000000082,

"expires_in": 31536000000

}

}

失败示例:

{

"code": 800054,

"data": null,

"message": "user name or password input error"

}

刷新token

  • 接口描述:使用refresh_token调用刷新token接口,获取新的token和refresh_token,一般用于token过期后获取新的token。

  • URL地址:http://ip:port /wapi/v1/refresh_token

  • 访问方法::Post

  • 请求参数:

    Headers中传入Refresh-Token

  • 响应示例:

成功示例:

{

"code": 200,

"message": "success",

"data": {

"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJsdWNpIiwibmFtZSI6Imx1Y2kiLCJleHAiOjE3MzcwMTE4NjMsImlhdCI6MTczNzAxMTI2M30.JDQG3nqelBM7KHUz0TXYgIMFQNCp53P-agpTrmSfgFLlqaETlyTJxg31roOM4TcjQppTlU20hdEXlIb-E3-aYQ",

"refresh_token": "eyJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEYXRlIjoiMjAyNS0wMS0xNlQwNzo0Nzo0My40NzhaIn0.v_2udwuqLZAMAmBHs-tug5Y82DOobAihwVexn8ueNgQ",

"expires": 600000,

"authority": "Admin",

"token_type": "bearer",

"issued": "2025-01-16T15:07:43.497",

"user": "luci",

"userId": 94000000000082

}

}

退出登录

  • 接口描述:退出登录,会将用户信息发送给mq服务器,用于日志记录用户退出登录日志。
  • URL地址:http://ip:port /wapi/v1 /loginOut/mq_log
  • 访问方法::Post
  • 请求参数:null
  • 响应示例:

{

"code": 200

}

最近修改: 2025-02-28