身份认证

1. 获取用户授权

前端： 陈小欢
后端： 左艺询
url： v1/homing/wecom/wc/auth/getAuthUrl

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

homingClient.wxqy.getAuthUrl({ 
  scope: '', 
  corpId: "", 
  suiteId: ""
}).then((res: any) => {
  if (res?.redirectUrl) {
    window.location.href = res.redirectUrl; // 后台返回重定向url
  } else {
    return new Error();
  }
});

参数说明

参数名	类型	必填	说明	备注/枚举值
scope	string	是	授权范围	snsapi_privateinfo手动授权，snsapi_base：静默授权
corpId	string	是	企业的corpId
suiteId	string	是	应用模版id

响应说明

字段名	类型	说明
redirectUrl	string	重定向url。企业微信会把code码返回到redirectUrl中拼接带回

2. 获取用户信息

前端： 陈小欢
后端： 左艺询
url： v1/homing/wecom/wc/auth/getUserInfo

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

homingClient.wxqy.getUserInfo({ 
  code: "", 
  corpId: "", 
  suiteId: "" 
}).then((res: any) => {
  console.log(res, '用户信息');
}).catch(() => {
  return new Error('code过期');
});

参数说明

参数名	类型	必填	说明	备注/枚举值
code	string	是	授权码	调用getAuthUrl，企业微信会把code码返回到redirectUrl中拼接带回
corpId	string	是	企业的corpId
suiteId	string	是	应用模版id

响应说明

字段名	类型	说明
userId	string	成员UserID。若需要获得用户详情信息，可调用通讯录接口：读取成员。如果是互联企业/企业互联/上下游，则返回的UserId格式如：CorpId/userid
userTicket	string	成员票据，最大为512字节，有效期为1800s。scope为snsapi_privateinfo，且用户在应用可见范围之内时返回此参数。后续利用该参数可以获取用户信息或敏感信息，参见"获取访问用户敏感信息"。暂时不支持上下游或/企业互联场景

3. 获取用户敏感信息

前端： 陈小欢
后端： 左艺询
url： v1/homing/wecom/wc/auth/getUserDetail

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

homingClient.wxqy.getUserDetail({ 
  userTicket: ""
}).then((res: any) => {
  console.log(res, '用户信息');
}).catch(() => {
  return new Error('userTicket过期');
});

参数说明

参数名	类型	必填	说明	备注/枚举值
userTicket	string	是	用户票据	通过homingClient.wxqy.getUserInfo api返回

响应说明

暂时无法在飞书文档外展示此内容