开发 API 开放接口 登录 ks.login
# ks.login
更新时间:2024-09-19 14:44:22
获取用户登录凭证,进而获取用户登录态信息。详见 登录。
# login(options: LoginOptions): Promise<LoginResult>
# 参数
| 参数 | 类型 | 必填 | 
|---|---|---|
| options | LoginOptions | 是 | 
# LoginOptions
属性
| 属性 | 类型 | 默认值 | 必填 | 说明 | 
|---|---|---|---|---|
| timeout | number | 60000 | 否 | 超时时间 (ms) | 
| success | (result: LoginResult) => void | 否 | 接口调用成功的回调函数 | |
| fail | (error: APIError) => void | 否 | 接口调用失败的回调函数 | |
| complete | (resultOrError: LoginResult | APIError) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 
# 返回值
# Promise<LoginResult>
LoginResult
属性
| 属性 | 类型 | 说明 | 
|---|---|---|
| code | string | 用户登录凭证(有效期五分钟) | 
# 错误信息
| 错误信息 | 错误说明 | 
|---|---|
| Invalid appId | 应用不存在 | 
| appType not allowed/userId is not app member | 请求被拒绝,可能是无效token或应用/用户不允许访问该接口 | 
# 扫码体验
# 示例代码
        上一篇:《ks.checkSession》
    
 下一篇:《ks.navigateToMiniProgram》
仍有疑问? 前往社区提问