# Function: login
▸ login(params?: LoginParams): Promise‹LoginRes›
调用接口获取登录凭证（code）
description 通过凭证进而换取用户登录态信息，包括用户的唯一标识（openid）及本次登录的会话密钥（session_key）等。
description 用户数据的加解密通讯需要依赖会话密钥完成。
description 注意：在有乐平台，返回的 code 是一个多行文本(由英文半角逗号分隔)：
- 第一部分是 cymini 平台的 UserSign；
- 第二部分是 cymini 平台的 OpenId；
- 第三部分是 cymini 平台的 ServerType；
# 参数:
| 属性 | 类型 |
|---|---|
params? | LoginParams |
LoginParams
| 属性 | 类型 | 描述 |
|---|---|---|
timeout? | number | 超时时间 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
# 返回值:
Promise‹LoginRes›