登录流程

登录系统支持多种登录方式，包括个人和企业登录、邮箱/手机号登录、密码/验证码登录，以及第三方登录服务。此外，还支持谷歌MFA（多因素认证）。

功能特点

• 个人/企业登录：支持个人用户和企业用户的登录需求。

• 邮箱/手机号登录：用户可以选择使用邮箱或手机号进行登录。

• 密码/验证码登录：提供密码登录和验证码登录两种方式。

• 第三方登录：支持Google、Facebook、Twitter、Telegram、Apple和MetaMask等第三方登录。

• 谷歌MFA身份认证：增强账户安全性，支持谷歌MFA认证。

涉及接口

登录接口

• 接口地址：/login/customer.app.CustomerWebApiService.login

• 功能：处理用户登录请求。

• 注意事项：登录密码需在前端进行MD5加密后传输，禁止明文传输。

国家地区查询接口

• 接口地址：/global/config.app.AppDictDubboService.getCountryListByParentCode

• 功能：根据国家代码查询国家地区列表。

支持企业开户国家查询接口

• 接口地址：/global/customer.app.KycWebApiService.findCompanyCountry

• 功能：获取支持企业开户的国家列表。

检测客户信息接口

• 接口地址：/global/customer.app.CustomerWebApiService.checkStatus

• 功能：检测客户信息是否有效。

发送验证码接口

• 接口地址：/global/message.app.VerificationApiService.verifyCodeSend

• 功能：向用户发送验证码。

检测谷歌MFA状态接口

• 接口地址：/global/customer.app.CustomerWebApiService.checkGoogleMFAStatus

• 功能：检测客户是否已开启谷歌MFA。

接口使用说明

在调用接口之前，请确保您已经认真阅读了相关的接口文档。以下是针对不同登录方式的具体说明：

1. 密码登录

邮箱登录

1. 登录

   • 使用登录接口，传入loginName, loginPwd, type,参数。

   • {
       // 用户登录名，支持邮箱或手机号格式
       "loginName": "[email protected]",               
     
       // 用户登录密码（MD5加密后传输，禁止明文传输）
       "loginPwd": "3e20062d9a45df86f2180cfc68580aaa", 
     
       // 登录类型：1 表示邮箱登录，2 表示手机号登录
       "type": 1                                
     }
     

   • 注意事项：登录密码在前端需进行MD5加密后再传输，禁止明文传输。

手机号登录

1. 获取国家区号数据

   • 调用国家地区查询接口获取国家区号数据。

2. 登录

   • 使用登录接口，传入loginName, loginPwd, type, phoneArea参数。具体参数说明阅读接口文档

   • {
       // 用户登录名：手机号
       "loginName": "68423752",               
     
       // 用户登录密码：使用 MD5 加密后传输，禁止明文传输
       "loginPwd": "3e20062d9a45df86f2180cfc68580aaa", 
     
       // 登录类型：2 表示使用手机号登录
       "type": 2,                            
     
       // 国家区号：从国家列表接口中获取，例如 "+852"
       "phoneArea": "+852"                   
     }

2. 验证码登录

1. 验证客户信息

   • 使用检测客户信息接口，确保账户存在。

   • {
       // 用户登录名：手机号
       "loginName": "68423752",              
     
       // 登录类型：2 表示使用手机号登录
       "type": 2                             
     }
     

2. 发送验证码

   • 调用发送验证码接口，获取发送验证码成功的票据（sendToken）。

   • {
       // 业务类型：EMAIL_LOGIN_VERIFICATION_CODE 表示邮件登录验证码，
       // SMS_LOGIN_VERIFICATION_CODE 表示短信登录验证码
       "bizType": "SMS_LOGIN_VERIFICATION_CODE",
     
       // 用户接收目标：手机号应包含国家区号，如 "[phone]"，
       // 或邮箱地址，如 "[email protected]"
       "toUser": "[phone]"
     }
     

3. 完成登录

   • 使用登录接口，传入loginName, type, phoneArea, sendToken, verifyCode参数。具体参数说明阅读接口文档

   • {
       // 用户登录名：手机号
       "loginName": "68423752",              
     
       // 登录类型：2 表示使用手机号登录
       "type": 2,                            
     
       // 国家区号：例如 "+852"，用于确保手机号格式正确
       "phoneArea": "+852",                  
     
       // 验证码发送票据：在发送验证码后获得，用于验证
       "sendToken": "ac233902-e270-4c23-98b1-c10f431b1474", 
     
       // 验证码：用户输入的验证码，用于完成登录
       "verifyCode": "452330"                
     }
     

• 注意事项

  • 账号验证：在发送验证码之前，必须验证账号是否存在。

  • 验证码票据：sendToken参数是发送验证码接口成功后返回的票据，用于验证验证码的有效性。

3. 谷歌MFA身份认证

1. 检测用户是否启用 Google MFA

   • 使用检测谷歌MFA状态接口，该接口将返回一个整数，用于指示用户的谷歌MFA状态，大于0，开启，其余未开启

2. 登录接口（增加Google MFA支持）

   • 使用登录接口，传入loginName, type, phoneArea, googleCode参数。具体参数说明阅读接口文档

   • {
       // 用户登录名：手机号
       "loginName": "68423752",              
     
       // 登录类型：2 表示使用手机号登录
       "type": 2,                            
     
       // 国家区号：例如 "+852"，用于确保手机号格式正确
       "phoneArea": "+852",                  
     
       // 谷歌验证码：用户从 Google Authenticator 获取的 6 位动态验证码
       "googleCode": "234512"                
     }
     

• 注意事项：googleCode是从Google Authenticator中获取的6位验证码，用于MFA验证。

常见问题

登录成功后返回的token有效期是多久？

• Token有效期：登录成功返回的token有效期为2个小时。

• 自动续期：在2小时有效期内，如果收到请求，token将自动续期2个小时。