1. 用户登录
开放平台用户登录接口,此接口仅提供给项目和企业大屏使用
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/user/login |
请求方法 | POST |
请求数据类型 | JSON |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
Content-Type | application/json;charset=UTF-8 |
1.2.2. 请求体(request-body)
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
phone | string | 是 | 手机号 |
password | string | 是 | 密码(MD5加密) |
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 返回码 |
message | string | 是 | 返回消息 |
data | object | 是 | 返回数据 |
userId | string | 是 | 用户ID |
username | string | 是 | 用户名 |
phone | string | 是 | 手机号 |
响应数据结构如下所示:
{
"code": 0,
"message": null,
"data": {
"userId": "XXX",
"username": "XXX",
"phone": "XXX"
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。