认证授权

1. 手机号登录（loginBySmsCode）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/auth/employee/login/mobile/switch
备注： 员工登录-短信验证码登录（包含企业-店铺-应用）

//! 注意，TS版本4^
import type { LoginBySmsCodeReq, LoginBySmsCodeRes } from '@homing/web'

try {
    const data: LoginBySmsCodeRes = await client.loginBySmsCode({
        mobile: '13800138000',
        mobileCode: '123456'
    } as LoginBySmsCodeReq);
    if (data?.userCode) {
        console.log('登录成功', data.token);
        console.log('用户编码', data.userCode);
    }
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	必填	说明	备注/枚举值
mobile	string	是	手机号
mobileCode	string	是	短信验证码
socialUserId	string	否	社交用户ID

响应说明

字段名	类型	说明
token	string	登录凭证
userCode	string	用户编码
valiCodeImg	string	验证码图片
expireIn	string	过期时间

2. 获取短信验证码（getSmsCode）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/auth/employee/login/get-mobile-code
备注： 员工登录-获取短信验证码

homingClient.getSmsCode({
  mobile: '13800138000'
}).then((res: any) => {
  console.log('验证码发送成功，超时时长：', res.expireIn);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
mobile	string	是	手机号

响应说明

字段名	类型	说明
expireIn	number	超时时长

3. 账号密码登录（login）

homingClient.login({
  mobile: '13800138000',
  passwd: 'your_password',
  imgCode: '1234'
}).then((res: any) => {
  if (res?.token) {
    console.log('登录成功', res.token);
  }
});

参数说明

参数名	类型	必填	说明	备注/枚举值
mobile	string	是	手机号码
passwd	string	是	密码
imgCode	string	否	图片验证码

响应说明

字段名	类型	说明
token	string	用户认证令牌
userCode	string	用户编码
valiCodeImg	string	图片验证码（可能在某些场景下返回）
expireIn	string	令牌过期时间

4. 登出（logout）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/auth/employee/logout
备注： 无

homingClient.logout().then(() => {
  console.log('登出成功');
});

参数说明

无

响应说明

无

5. 刷新图片验证码（refreshImageCode）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/auth/employee/login/refresh-vali-code
备注： 员工登录-刷新图形验证码

homingClient.refreshImageCode().then((res: any) => {
  if (res?.valiCodeImg) {
    console.log('获取验证码成功', res.valiCodeImg);
  }
});

参数说明

无

响应说明

字段名	类型	说明
valiCodeImg	string	图片验证码（Base64编码）
expireIn	number	超时时长

6. 忘记密码获取短信验证码（getSmsCodeForForgotPassword）

前端： 谭海涛
后端： 胡伟
url： /v1/homing/auth/employee/forgot/get-mobile-code
备注： 员工忘记密码-获取短信验证码

homingClient.getSmsCodeForForgotPassword({
  mobile: '13800138000'
}).then((res) => {
  // 返回超时时长
    console.log('验证码发送成功，超时时长：', res.expireIn);
});

参数说明

参数名	类型	必填	说明	备注/枚举值
mobile	string	是	手机号码

响应说明

无

7. 通过短信验证码重置密码（resetPasswordWithSmsCode）

前端： 谭海涛
后端： 冀晋星
url： /v1/homing/auth/employee/forgot/update-passwd
备注： 员工忘记密码-找回密码

homingClient.resetPasswordWithSmsCode({
  mobile: '13800138000',
  mobileCode: '123456',
  passwd: 'new_password'
}).then(() => {
  console.log('密码重置成功');
});

参数说明

参数名	类型	必填	说明	备注/枚举值
mobile	string	是	手机号码
mobileCode	string	是	短信验证码
passwd	string	是	新密码

响应说明

无

8. 智桂通登录（zgt.login）

前端： 谭海涛
后端： 章强
url： /v1/homing/auth/customer/login/zgt/token
备注： 智桂通登录

//! 注意，TS版本4^
import type { ZgtLoginByAuthCodeRes } from '@homing/web'

try {
    const data: ZgtLoginByAuthCodeRes = await client.zgt.login(croods);
    console.log('调用成功', data);
} catch (error: any) {
    console.log(error, '调用失败' + error?.message);
}

参数说明

参数名	类型	是否必填	说明	备注/枚举值
croods	any	是	croods实例，用于调用智桂通插件	智桂通SDK实例对象
token	string	否	第一优先级token	传入之后跳过智桂通login，直接调用业务login

响应说明

字段名	类型	说明	备注/枚举值
token	string	访问Token，调用接口需携带	必填
accountId	number	用户id	必填
accountCode	string	用户编号	必填
expireIn	string	验证码超时时长（单位：秒）	必填
oldCustomerFlag	number	新老客标识	0新客 1老客，必填
lastLoginTime	string	顾客上次登录时间	必填
lastTestTime	number	顾客最后一次测肤时间	必填
loginStatus	string	顾客登录状态	'success' | 'fail' | 'scanning' | 'logging' | 'write_questionnaire' | 'need_add_info'，必填
customerId	number	顾客ID	必填
customerCode	string	顾客Code	必填
nickname	string	顾客昵称	必填
realName	string	顾客姓名	必填
avatar	string	顾客头像	必填
trueImg	string	顾客真实头像	必填
tenantCode	string	租户code	必填
orgId	number	机构标识	必填
orgCode	string	机构code	必填
alreadyRegister	string	是否已经注册	必填