接口调用说明
# 请求数据
测试地址:`http://192.168.1.127:9001`
线上地址:`http://api.feifubao.com.cn/`
接口环境:`vnd`
接口名称:`renovation`
版本号:`v1`
# 请求头
### Accept 报头
接口通过http传输的Accept报头进行接口版本控制,格式如下
`Accept:application/[接口环境].[接口名称].v[接口版本]+json`
举例:
当前接口环境为 **vnd**
接口名称为 **renovation**
版本号为 **v1**
将拼接如下的报头进行http请求方可获得适用的版本控制
`Accept:application/vnd.renovation.v1+json`
### token 用户令牌
接口中需要用户授权的部分,将在http头部传输Authorization用户令牌进行验证
# 异常
### 数据验证
接口post数据时,对于数据验证部分会统一返回异常code 422,并按照如下格式返回错误信息。
其中英文部分会在后期做本地化优化。
msg 字段是对于错误的描述
errors 字段将详细的展示每个参数的具体错误信息
code 字段统一为-1,
status 当前的http返回码
例:
```
{
"msg": "提交的数据验证不通过:The mobile field is required.",
"errors": {
"mobile": [
"The mobile field is required."
],
"code": [
"The code field is required."
],
"mac_address": [
"The mac address field is required."
]
},
"code": -1,
"status": 422
}
```
### 用户认证异常
当用户的令牌已过期,或令牌有误的情况下,将会按照如下格式返回
```
{
"msg": "用户已过期,请重新登录",
"code": -9,
"status": 200
}
```
当用户的状态异常,或被管理员禁用,将会按照如下格式返回
```
{
"msg": "当前用户已被管理员禁用,请联系管理员",
"code": -8,
"status": 200
}
```