功能描述:

  • JSON Web Token(缩写 JWT)是鉴权认证解决方案,所有数据都保存在客户端,每次请求都发回服务器。

基本原理:

  1. 在接口参数配置设定 JWTKEY 的值,可以自定义配置或随机生成。鉴权模式选择为“jwt” 或 “both”。
    在htttp://127.0.0.1:8090的接口系统的系统设置页面
    接口JWT配置

  2. 后台程序生成 JWT Token 值,根据接口配置 JWTKEY 来生成。生成好的 JWT Token 页面加载时保存到客户端。数据格式:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDAxNjMyMzIsImV4cCI6MTYwMDE2NjgzMn0.R_jiD3I5WbdubNxXoF8Lee4pAUN711RMiQKe_WJ8bGo
  1. 客户端调用呼叫中心接口,请求参数中添加jwttoken值为后台生成的token,值用于鉴权值。
  2. 返回接口请求状态。
  3. 建议使用官方提供第 JWT 类库生成 JWT Token。获取生成 JWT 类库,请访问JWT 官网

请求 URL:

http://x.x.x.x:8090/v2/xxxapp

注:调用呼叫操作时,参数jwttoke。其中xxxapp为具体应用名称,例如:dail 等。

请求方式:

  • POST

请求必填参数:

参数名 是否必须 类型 说明
jwttoken string jwt token 加密的值

返回示例:

正确时返回:

{
    "success": true,
    "code": "100000",
    "msg": "操作成功",
    "data": null
}

错误时返回:

{
    "success": true,
    "code": "100150",
    "msg": "jwt过期时间为必填项",
    "data": null
}

注:根据不同情况返回不同结果码

返回参数说明:

参数名 类型 说明
success string 请求的状态,true:请求成功,false:请求失败
code string(6) 结果码,用于区分状态类型
msg string 描述内容
data json 用于处理数据,此处值为:null

状态码:

结果码 描述 处理方法
100000 请求成功 请求的状态,true:请求成功,false:请求失败
100100 连接呼叫模块失败 检查接口中呼叫中心配置地址。
100500 jwt 过期时间为必填项 过期时间为必填参数
100501
文档更新时间: 2022-10-19 08:40   作者:admin