kuaihuoyun_gps

TMS三方设备GPS接口文档

目录

• 接口简介
• 对接流程
• 接口详细信息
  • 添加设备接口
  • 上传设备状态位置数据接口
  • 移除设备接口
• 其他问题

接口简介

用于对接三方设备的GPS数据，目前GPS相关接口有：

• 添加设备接口
• 上传设备状态位置数据接口
• 移除设备接口

传参方式如无特殊说明均为application/json格式。不支持将参数写进url中传递。小黑卡用户不需要此接口。

对接流程

1.获取token

此部分请参考3TMS/CTMS第三方接口文档中的： 接口简介 、 接口说明 以及 获取登陆凭证接口 部分。

2.添加设备

在上传设备信息之前，首先需要将设备添加进系统中，注意，此处的添加不是在TMS系统中添加，而是调用添加设备接口进行添加，这是两个不同的数据表，如果没有添加会提示设备不存在。设备只需添加一次即可。

3.上传设备状态及位置

添加完设备以后可以调用上传设备状态位置数据接口进行数据上传。

4.删除设备

三方设备的上限是500台，超过将无法添加新的设备，必须要删除部分设备才能继续添加。

接口详细信息

添加设备接口

1.简要描述 ：用于添加设备，设备上限为每个账号最多500台。

2.请求URL ：/gps/add_device

3.请求方式 ：POST

4.调用频率限制 ：同一设备号一小时内只能添加一次

5.请求参数 ：

参数名	必选	类型	说明
deviceNumber	是	String	设备号

6.返回示例 ：

• 调用成功示例：

  {
  "code": 200,
  "message": null,
  "data": true
  }
  

• 调用失败示例： ```java { "message": "操作太频繁", "status": 500 }

{

"message": "设备浙A34421已存在",
"status": 500

}

### 上传设备状态位置数据接口

**1.简要描述** ：上传设备状态位置数据。

**2.请求URL** ：`/gps/push_gps_data`

**3.请求方式** ：POST

**4.调用频率限制** ：一个账号一小时内只允许调用5000次

**5.请求参数** ：

| **参数名** | **必选** | **类型** | **说明** |
| --- | --- | --- | --- |
| deviceNumber | 是 | String | 设备号 |
| locateTime | 是 | Integer | 轨迹上报时间，时间戳（单位：秒） |
| longitude | 是 | Double | 经度 |
| latitude | 是 | Double | 纬度 |
| locateType | 是 | Integer | 轨迹上报类型必填：(0：未知，1：GPS，2：基站定位，4：北斗定位，5：GPS 和北斗定位) |
| runStatus | 是 | Integer | 设备运行状态必填（1:行驶，2:停止，3:离线） |
| addr | 是 | String | 设备具体定位地址 |
| province | 是 | String | 定位省份 |
| city | 是 | String | 定位城市 |
| roadName | 是 | String | 定位具体街道 |
| powerRate | 否 | Integer | 设备电量（单位：%） |
| humidity | 否 | Double | 设备湿度（单位：度） |
| temperature | 否 | Double | 设备温度（单位：度） |
| speed | 否 | Double | 设备速度（单位：km／h） |
| direction | 否 | Double | 设备运动方向（单位：角度） |
| abnormalProfile | 否 | String | 异常点类型：简述 |
| abnormalInfo | 否 | String | 异常点内容：详细描述 |
| note1-12 | 否 | String | 自定义备注，共12个，用于额外的参数 |

**6.返回示例** ：
- 调用成功示例：
```java
{
    "code": 200,
    "message": null,
    "data": {
        "message": "成功",
        "success": true
    }
}

• 调用失败示例： java { "code": 200, "message": null, "data": { "message": "设备经纬度不能为空且必须大于0", "success": false } }

移除设备接口

1.简要描述 ：用于移除设备

2.请求URL ：/gps/remove_device

3.请求方式 ：POST

4.请求参数 ：

参数名	必选	类型	说明
deviceNumber	是	String	设备号

5.返回示例 ：

• 调用成功示例：

  {
  "code": 200,
  "message": null,
  "data": true
  }
  

• 调用失败示例：

  {
  "code": 200,
  "message": null,
  "data": false
  }
  

其他问题

1.如何在系统中查看上传的轨迹 进入TMS系统-->车队管理-->智能管车，点击列表，在底部进行添加设备

其中，车牌号需要先添加进车队管理-->车辆信息管理中，否则添加的时候会提示车辆不存在，设备ID对应你调用接口时传递的设备号，添加完成之后就完成了车辆与设备的绑定关系。车牌号可以与设备ID相同。

添加完成以后，在列表中点击车牌号则可以查看设备的最后一个定位点，点击设备号可以查看设备的轨迹信息。其余信息在操作的小齿轮中进行查看。