开发指南
1. 注意事项
1.1 关于变更和版本
本文档目前处于实时修订状态，发生变更时，直接修改文档内容，由编辑者自行通知受影响人员变更的内容。
当文档进入稳定阶段后，应该修改版本号，并禁止实时修订，而应使用变更列表形成下一版本。
1.2 弃用接口
弃用
@deprecated <=1.0.22
该标志标识该接口在1.0.22及之前的版本中使用，新的版本中应该使用新接口，而不要使用标记为deprecated的接口。
2. 请求地址
2.1 联调环境
https://dev.work.star-lock.cn/api/2.2 预发布环境
https://pre.work.star-lock.cn/api/3. 请求和响应的格式
3.1 请求成功
json
{
"errorCode": 0,
"description": "表示成功或是。",
"errorMsg": "success or means yes",
"data": null
}3.2 请求失败
json
{
"errorCode": 421,
"errorMsg": "滑动验证失败",
"description": "滑动验证失败",
"data": null
}3.3 验证错误
json
{
"errorCode": 422,
"errorMsg": "Validation Error.",
"description": "Validation Error.",
"data": {
"nickname": [
"必须输入。"
],
"email": [
"必须输入。"
],
"password": [
"必须输入。"
]
}
}3.4 服务器错误
json
{
"errorCode": 500,
"errorMsg": "Server Error.",
"description": "服务器错误。",
"data": null
}3.5 认证错误
json
{
"errorCode": 403,
"errorMsg": "Unauthenticated.",
"description": "登录状态已过期。",
"data": null
}4. 请求错误码
当 errorCode 不为 0 时，请按照下面错误码进行处理：
| 类型 | 代码 | 处理方法 |
|---|---|---|
| 无异常 | 0 | 正常使用 data 中的数据，可选使用 toast 显示 description 中内容 |
| 认证错误 | 403 | 清空本地 token 并跳到登录页面 |
| 服务器错误 | 500 | 弹出服务器错误提示框 |
| 操作错误 | 421 | 使用 toast 显示 description 中内容 |
| 操作错误 | 430 | 使用 toast 显示 description 中内容（该代码来自星云云端） |
| 用户不存在 | 425 | 一般用于使用用户名或者手机号查询用户，但没有找到，明确此用户；目前用于发送短信时返回 |
| 验证错误 | 422 | 使用 toast 显示 description 中内容 |
| 账号已被禁用 | 429 | 员工账号被冻结或者当前没有合作账户 |
| 数据不存在 | 10001 | 可能在其他客户端删除了该条数据，建议刷新该数据来源的列表页 |