# 用户登录

# 目录

# 接口说明

本接口用于实现自建应用的用户登录功能，为开发者提供便捷的用户信息持久化调用能力。

# 接口介绍

该接口可应用于各类需要登录访问的应用场景，通过简单的调用即可实现用户信息获取和鉴权，有效降低开发成本，提高开发效率。

# 接口配置入口

登录氦闪开发者平台 (opens new window)
"接口管理" 》 "平台接口" 》 "模块API" 》 "用户基础服务"
选择 "用户登录"
右上角选择开启

提示：此接口数据持久化使用mysql数据库，请确保已配置相关数据源。

# 接口调用

# 用户登录基本信息

接口地址：https://lb/business-service/api/open/auth/v1/login
返回格式：json
请求方式：POST
请求示例：

{
  "username": "用户名",
  "password": "自定义算法后的密码"
}

# 请求头：

参数名称	类型	说明	是否必填
APPID	string	开发者平台分配的应用APPID	是
_t	number	请求时间戳（毫秒级）	是
_s	string	签名信息，用于接口安全验证	是
_n	随机数	随机数	是

# 请求体（json）：

参数名称	类型	说明	是否必填
username	string	用户登录账号;	是
password	string	用户登录密码（需要摘要算法）	是

# 响应头：

参数名称	类型	说明	是否必填
connectionid	string	本次请求的唯一标识	是
_t	number	请求时间戳（毫秒级）	是
_s	string	签名信息，用于接口安全验证	是
_n	随机数	随机数（与本次请求的值一致）	是

# 返回参数（json）

参数名称	类型	说明
code	number	返回状态码，200 表示成功，其他表示失败
message	string	返回信息描述
data	object	返回信息摘要
info	object	业务信息
token	string	业务接口访问令牌，默认时效1小时
refreshToken	string	刷新令牌，默认时效16天

返回参数示例：

{
    "code": 200,
    "message": "操作成功",
    "data": "登录成功",
    "info": {
        "userInfo": {
            "roleInfos": null,
            "roleId": null,
            "avatar": null,
            "userId": "UID202604160001",
            "roleStatus": null,
            "realName": null,
            "password": null,
            "roleIds": [
                "RL202604160001"
            ],
            "size": null,
            "createTime": null,
            "phone": "13800138000",
            "roleCode": null,
            "roleName": null,
            "page": null,
            "email": null,
            "status": 1,
            "username": "admin"
        },
        "token": "eyJ0eXAiOiJKV1QiLCJ.eyJpYXQiOjE3N.UfhyIaxgR_KJ9G60es4gE",
        "refreshToken": "eyJ0eXAiOiJKV.eyJpYXQiOjE3.bUgstrmtfEKTA_zRDCSK89SaQ"
    }
}

← API总览刷新令牌 →