接口名称
预登录
接口地址
/api/platform/v1/preLogin
请求方式
POST
请求头
参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
Accept | String | 是 | 请求接受类型 |
Content-Type | String | 是 | 请求内容类型 |
language | String | 是 | 语言 |
语言取值:
值 | 说明 |
|---|---|
zh_CN | 中文 |
en_US | 英文 |
请求参数
参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
username | String | 是 | 用户名/邮箱 |
password | String | 是 | 密码 |
请求示例
curl 'https://tracking-qa.etowertech.com/api/platform/v1/preLogin' \
-X 'POST' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'language: en_US' \
-H 'Accept-Language: zh-CN,zh;q=0.9' \
--data-raw '{"username":"dongyangdeng@walltechsystem.cn","password":"xxxx"}'
返回示例
{
"success": true,
"code": "0",
"data": {
"user": {
"sessionId": "3WrzIxwRToTJRDdgRUMZFw",
"username": "dongyangdeng@walltechsystem.cn",
"id": 12508,
"tenantId": 1,
"tenantName": "Wall Tech Support Account",
"chineseName": "邓东阳",
"englishName": "dongyangdeng@walltechsystem.cn",
"type": 1,
"email": "dongyangdeng@walltechsystem.cn",
"phone": "",
"probation": false,
"roles": [],
"firstLogin": false
},
"tenantList": [
{
"partyId": 1,
"aggregator": true,
"name": "Wall Tech Support Account",
"chineseName": "Wall Tech Support Account",
"code": "WT",
"weightDifferenceRate": 0,
"weightDifferences": []
},
{
"partyId": 100,
"aggregator": true,
"name": "UBI Smart Parcel",
"chineseName": "利通智能包裹",
"code": "UBI",
"weightDifferenceRate": 0,
"weightDifferences": []
}
]
},
"errors": []
}
返回字段说明
字段 | 类型 | 说明 |
|---|---|---|
success | Boolean | 请求是否成功 |
code | String | 响应状态码,"0"表示成功 |
data | Object | 用户数据对象 |
errors | Array | 错误信息列表 |
data 字段说明
字段 | 类型 | 说明 |
|---|---|---|
user | Object | 用户信息对象 |
tenantList | Array | 租户列表数组 |
user 字段说明
字段 | 类型 | 说明 |
|---|---|---|
sessionId | String | 会话ID |
username | String | 用户名 |
id | Number | 用户ID |
tenantId | Number | 租户ID |
tenantName | String | 租户名称 |
chineseName | String | 中文名称 |
englishName | String | 英文名称 |
type | Number | 用户类型 |
String | 邮箱 | |
phone | String | 电话 |
probation | Boolean | 是否试用期 |
roles | Array | 角色列表 |
firstLogin | Boolean | 是否首次登录 |
tenantList 字段说明
tenantList 返回的是 租户列表数组。
字段 | 类型 | 说明 |
|---|---|---|
partyId | Number | 租户ID |
aggregator | Boolean | 是否聚合商 |
name | String | 租户名称 |
chineseName | String | 租户中文名称 |
code | String | 租户代码 |
weightDifferenceRate | Number | 重量差异率 |
weightDifferences | Array | 重量差异列表 |