简要描述：

-对象/邮箱验证码
-RG3.BO.Qu\Controller\VerifyCodeController.cs

接口版本：

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2023-11-23 xxxx-xx-xx

请求URL:

请求方式：

  • POST

请求头：

参数名 是否必须 类型 说明
XownerId 是 string 项目唯一ID,对应bo_project {ownerId}
XsysId 否 string 所属系统 对应 bo_system 表
XuserFromFirstShareId string 否 一级分享用户ID， bo_user user_id
XuserFromSecondShareId string 否 二级分享用户ID， bo_user user_id
XverifyApi 是 string 加密规则encryptByDES(`${newGuid()}
XfilterAreaCode 否 string 行政区编码， 对应 bo_sys_area area_code
Content-Type: 是 string application/json; charset=utf-8 请求类型

请求参数:

{
        verifyCode: "xuhd",
        verifyGuid: "rg01034e83f6d-c95e-4f43-b2ea-33ff17f",
        verifyObject:"加密值",
        verifyType: "email",
}
参数名 是否必须 类型 说明
depId 是 string 主键唯一标识值 (名称根据实际进行调整)
_nodejs 是 string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js， 通过nodejs插件，对响应结果进行二次处理 common-data 普通数据（小写驼峰）common-data-under 普通数据下划线
数据参数名 是否必须 类型 说明
verifyType 是 string 发送类型，email
verifyCode 否 string 图片验证码值
verifyGuid 否 string 图片验证码key
email 否 string 把邮箱通过 des进行加密

返回示例:

正确时返回:

{
        data: {
          second: 60,
          secondHt: 300,
          cacheKeyHt: "1816C409AB7FE0C83D7A0BF38A2435F8JJ__1",
          cacheStartDateHt: "0001-01-01T00:00:00",
        },
        code: 0,
        success: true,
      }

错误时返回:

{
    "code": 0,
    "message": ""
    "error":{
      errorCode:null，
      errorText:null
    }
    "success": false,
}

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功（跟code=0一致）,调用者优先使用
code int true 表示数据请求成功（跟code=0一致）,调用者优先使用
data object second: 60, //用于前端倒计时 secondHt: 300,//后端缓存数据时间 cacheKeyHt //后台存储缓存的key，需要传递给后台
cacheType string redis/sqlite/local 数据来源缓存 的类型（便于开发调试和性能优化）
cacheDate date 最后数据获取时间
文档更新时间: 2023-11-23 09:24   作者：admin
上一篇：
下一篇：