IconCreated with Sketch.

YAPI 接口文档

YApi
  • 公共分类
    • 私有云登录
    • 首次登录修改密码-real
    • 发送验证码--手机验证码登录
    • 获取密码策略--忘记密码
    • 发送邮箱验证码--忘记密码
    • 发送手机短信验证码--忘记密码
    • 首次登录初始化密码
    • 修改密码--忘记密码
    • 首次MFA验证--MFA功能
    • 非首次MFA验证--MFA功能

自定义开发登录功能

客户自定义开发登录使用到的接口,接口地址以login、ccsetup开头则代码是login服务、setup-svc服务 涉及后端服务:login,mainapi,apiservice

公共分类

私有云登录

基本信息

Path: /login/signin/logon

Method: POST

接口描述:

包含三种登录方式

  1. 账号密码登录
  2. 手机号密码登录
  3. 手机号验证码登录

RSA对AES密钥加密,作为请求参数
AES对敏感数据加密,做为请求参数

前端每次请求自动生成AES密钥,并使用AES对请求参数中的敏感信息进行加密,格式为:
1\. 账号密码登录
{
  "username": "用户名",
  "password": "密码"
}

2. 手机号密码登录

{
  "mobilePhone": "手机号",
  "password": "密码" 
}

3. 手机号验证码登录

{
  "mobilePhone": "手机号",
  "verificationCode": "验证码"
}

注意:密文全部使用BASE64编解码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
explorer text 是
operatingSystem text 是 Windows
rtnURL text 是
serviceName text 是 手机验证码登录时为mobileVerificationCodeLogin,其他情况为随机码
rp text 是 不同登录方式的主要信息,包含用户名、密码、手机号、验证码
sk text 是 使用公钥对AES密钥进行加密,加密后的字符串

返回数据

名称类型是否必须默认值备注其他信息
dataobject非必须
├─ usernamestring非必须
├─ rtnURLstring非必须
├─ randomNumstring非必须
├─ loginnumstring非必须
├─ urlstring非必须
├─ lightingWebUrlstring非必须
├─ versionstring非必须
├─ currDaystring非必须
├─ upgradeboolean非必须
├─ upgradeDescribenull非必须
├─ upgradeTitlenull非必须
├─ freshTokenstring非必须
├─ accessTokenstring非必须
├─ languagestring非必须
├─ passwordExpireboolean非必须该参数代表是否首次登录修改密码和过期修改密码
├─ autoRegisterboolean非必须
├─ gatewayUrlstring非必须
├─ partneraddressnull非必须
├─ pageOverTimestring必须mfa返回
├─ mfaRandomKeystring必须mfa返回
├─ mfaRandomstring必须mfa返回
├─ qrCodestring必须mfa返回
├─ bindingstring必须mfa返回
├─ statusstring必须mfa返回
requestIdstring非必须
returnCodestring非必须
returnInfostring非必须
customInfonull非必须
resultboolean非必须
stackTracenull非必须
errorSQLnull非必须

首次登录修改密码-real

基本信息

Path: /api/srcLogin/modifyPwWhenFirLog

Method: POST

接口描述:

使用RSA+AES混合密码对敏感信息进行加密
前端生成AES密钥,使用RSA对AES密钥加密
AES对敏感数据进行加密

{
  "newPassword": "新密码",
  "oldPassword": "旧密码",
  "modifyPwType": ""
}
modifyPwType为autoRegister时,不需要oldPassword参数

注意:密文都使用BASE64进行编码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
skstring非必须RSA加密的AES秘钥
rpstring必须AES加密的请求数据

返回数据

名称类型是否必须默认值备注其他信息
resultboolean非必须
dataobject非必须
├─ accessTokenstring非必须

发送验证码--手机验证码登录

基本信息

Path: /api/mobileNoBinding/sendMessageForLogin

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
mobilestring非必须
langstring非必须
countryCodestring非必须

返回数据

名称类型是否必须默认值备注其他信息
dataobject非必须
├─ resultboolean非必须
requestIdstring非必须
returnCodestring非必须
returnInfostring非必须
customInfonull非必须
resultboolean非必须
stackTracenull非必须
errorSQLnull非必须

获取密码策略--忘记密码

基本信息

Path: /api/mobileNoBinding/getPasswordPolicy

Method: POST

接口描述:

pswComplexReq:0代表无要求,1代表包含字母和数字,2代表必须包含大小写字母及数字,3代表必须包含大小写字母及数字和符号
minPswLength 最小密码长度

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
mobilestring非必须

返回数据

名称类型是否必须默认值备注其他信息
dataobject非必须
├─ resultstring非必须
├─ pswComplexReqstring非必须
├─ minPswLengthstring非必须
requestIdstring非必须
returnCodestring非必须
returnInfonull非必须
customInfonull非必须
resultboolean非必须
stackTracenull非必须
errorSQLnull非必须

发送邮箱验证码--忘记密码

基本信息

Path: /api/emailObject/sendEmailForChangePassword

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
loginNamestring非必须
langstring非必须

返回数据

名称类型是否必须默认值备注其他信息

发送手机短信验证码--忘记密码

基本信息

Path: /api/mobileNoBinding/sendMessageForChangePassword

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
mobilestring非必须
langstring非必须
countryCodestring非必须

首次登录初始化密码

基本信息

Path: /ccsetup/api/accessApi/login/userPwModify

Method: POST

接口描述:

使用RSA+AES混合密码对敏感信息进行加密
前端生成AES密钥,使用RSA对AES密钥加密
AES对敏感数据进行加密

{
  "newPassword": "新密码",
  "oldPassword": "旧密码",
  "modifyPwType": ""
}

注意:密文都使用BASE64进行编码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
accessToken eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ2ZXJzaW9uVHlwZSI6IlVubGltaXRlZCIsImF1ZCI6ImNsb3VkY2MiLCJsb2dpbk5hbWUiOiJsaXV0ZXN0MUBub2tpYS1zYmVsbC5jb20iLCJiaW5kaW5nIjoiY2VjYTg5MDBjOGYwNDExNjg1ZjMzNWM0NDA3MDU5NzMiLCJ1c2VySWQiOiIwMDUyMDIzNjBGMzdBQUJUY3kzSyIsIm9yZ0lkIjoiZXhvcmcyMDIzMjg2OTY5N3Rlc3QifQ.0wDX5TKTkuOQh9YeSKcQ_6O52ofDcWf7sLL4-uQnoDI 是

Body

名称类型是否必须默认值备注其他信息
skstring必须RSA对AES密钥加密后的密文
rpstring必须AES加密后的请求参数

修改密码--忘记密码

基本信息

Path: /api/mobileNoBinding/userPwModify

Method: POST

接口描述:

使用RSA+AES混合加密方式对敏感信息进行加密
前端动态生成AES密钥,RSA对AES密钥进行加密
前端使用AES对敏感信息进行加密,格式如下:
邮箱验证方式:

{
  "loginName": "登录名",
  "newPw": "新密码",
  "verificationCode": "验证码"
}

手机号验证方式:

{
  "mobile": "手机号",
  "newPw": "新密码",
  "verificationCode": "验证码"
}

注意:密文使用BASE64进行编解码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
skstring非必须RAS对AES密钥加密后的密文
rpstring非必须AES对敏感信息加密后的密文
langstring非必须
noCheckOldPwstring非必须固定值 “1”

返回数据

名称类型是否必须默认值备注其他信息

首次MFA验证--MFA功能

基本信息

Path: /api/srcLogin/getMFAQrCodeImg

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
codestring必须登录接口返回的qrCode
multipleCodestring非必须传"true"就行
rSizestring必须传650就行,图片的宽和高

返回数据

名称类型是否必须默认值备注其他信息

非首次MFA验证--MFA功能

基本信息

Path: /api/srcLogin/mfaVerification

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
verificationCodestring非必须MFA验证码
mfaRandomKeystring非必须随机key
mfaRandomstring非必须随机数
bindingstring非必须登录标识

Build by YMFE.