一、通用说明

1. API地址

当前版本:http://api.anxinjoy.com:3300/

2. 通用类型说明

3. 返回状态说明

状态码                                 含义
200 OK                              GET请求成功
202 ACCEPTED                        POST请求成功
400 BAD REQUEST                     POST请求失败或GET请求参数有误
403 FORBIDDEN                       token无效,被禁止访问
404 NOT FOUND                       请求的资源不存在
500 INTERNAL SERVER ERROR           内部错误

4. 授权

访问资源时,需要先向服务器申请一个token,申请方法请参照: 4.1 token请求方法

在访问所有资源时,需要带上这个token,形如:

GET http://{host}:{port}/{action}/{params}?token={申请到的token}

注意:每个token的有效期为30分钟

可请求token续期接口,为token续期30分钟,token续期的方法参照: 4.2 token续期

当然,出于安全考虑,你也可以选择强制使一个token过期,token过期的方法参照:4.3 使token过期

4.1 token请求方法

URL: POST http://api.anxinjoy.com:3300/service/token/apply

请求:

POST http://api.anxinjoy.com:3300/service/token/apply

参数:

{
    "username"  :   "995bCfY7RM",
    "random"    :   "79454C52",
    "sig"       :   "26febe3b0bd2f144661bb796562535bf"
}

返回:

状态码:202
{
    "res"       :   true,
    "token"     :   "25E1A4C6538BF0376331145E87CD4358"
}

4.2 token续期

URL: POST http://api.anxinjoy.com:3300/service/token/alive

请求:

POST http://api.anxinjoy.com:3300/service/token/alive

参数:

{
    "token"     :   "25E1A4C6538BF0376331145E87CD4358",
    "random"    :   "79454C52",
    "sig"       :   "84fcd88c00f119fad28d7ca2b85061a7"
}

返回:

状态码:202
{
    "res"   :   true
}

注意:该操作只有再token有效期小于10分钟时生效,请不要频繁请求该操作,存在对频繁请求的IP进行一段时间封停的可能

4.3 使token过期

URL: POST http://api.anxinjoy.com:3300/service/token/drop

请求:

POST http://api.anxinjoy.com:3300/service/token/drop

参数:

{
    "token"     :   "25E1A4C6538BF0376331145E87CD4358",
    "random"    :   "79454C52",
    "sig"       :   "84fcd88c00f119fad28d7ca2b85061a7"
}

返回:

状态码:202
{
    "res"   :   true
}

二、结构物

1. 获取用户结构物列表

URL: GET http://api.anxinjoy.com:3300/service/api/user/structs

三、监测因素

1. 获取结构物监测因素

URL: http://api.anxinjoy.com:3300/service/api/struct/{structId}/factors

四、传感器

1. 获取结构物下用于监测因素的传感器

URL:http://api.anxinjoy.com:3300/service/api/struct/{structId}/factor/{factorId}/sensors

五、监测数据

1. 获取传感器的监测数据

URL:http://api.anxinjoy.com:3300/service/api/sensor/{sensorId}/data/{startDate}/{endDate}/1/second/false

2. 获取振动批次

URL:http://api.anxinjoy.com:3300/service/api/vibration/{sensorId}/data-batch/{startDate}/{endDate}

3. 获取振动频谱数据

URL:http://api.anxinjoy.com:3300/service/api/vibration/{batchId}/spectrum-data

4. 获取振动时域数据

URL:http://api.anxinjoy.com:3300/service/api/vibration/{batchId}/original-data

六、获取阈值

1. 获取传感器阈值信息

URL:http://api.anxinjoy.com:3300/service/api/find/sensor/{sensorId}/threshold