接口说明
设备添加接口
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/api/evo/device
请求Method
POST
数据提交格式
application/json
DeviceAddRequest参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| deviceManufacturer | 是 | string | 生产厂商,1 - 大华 |
| deviceCategory | 是 | int | 设备大类 出入口设备35、道闸设备36、显示设备37、自助设备38 |
| deviceType | 是 | string | 设备小类,与设备大类的关系见备注 |
| loginType | 是 | string | 登录方式(1:ip地址 6:主动注册) |
| ownerCode | 是 | string | 所属组织 |
| deviceIp | 是 | string | 设备ip |
| devicePort | 是 | string | 设备端口 |
| loginName | 是 | string | 登录名 |
| loginPassword | 是 | string | 登录密码 rsa加密,加密公钥调用获取公钥获取用于RSA加密 |
| deviceName | 是 | string | 设备名称 |
| devExt | 否 | jsonObject | 设备扩展属性 |
| +serverCode | 否 | string | 接入的服务编码 |
| +screenType | 否 | string | 屏幕型号,显示设备时必填 |
| units | 是 | array | 通道列表 |
| +unitType | 是 | string | 单元类型: 1视频单元、14道闸单元 16显示单元 |
| +unitExt | 否 | jsonObject | 单元扩展属性 出入口设备添加显示通道时需要填写 |
| ++use | 是 | string | 用途: 1诱导屏、2余位屏、3通用屏 |
| +channels | 是 | array | 通道列表 |
| ++channelName | 是 | string | 通道名称 |
| ++channelSeq | 是 | int | 通道序号 |
请求参数示例
{
"deviceManufacturer": "大华",
"deviceCategory": 36,
"deviceType": 1,
"loginType": "1",
"ownerCode": "001",
"videoServerCode": "video#local",
"deviceIp": "20.31.21.25",
"devicePort": "37777",
"loginName": "admin",
"loginPassword": "KkZdhvxlbwG3W5NT2xhV+bk1QUJFGZvfBET/3+wNRsrQqwcryhi+8E5JSZQXJBGfgQmlJlHqv8mPio6kZCRHKbngUIlrejq+cirOdkNLbHPOnhBkUhesMLNyGNB4YMqdeiKBRMKnZZtPfBs/rDEZYh0dUfmM7LCa/OP3JWUVGyM=",
"deviceName": "132",
"deviceModel": 4,
"ownerCode": "001",
"devExt": {
"videoServerCode": "video#local"
},
"units": [
{
"unitType": 14,
"channels": [
{
"channelName": "132_道闸通道_1",
"channelSeq": 0,
"gpsX": null,
"gpsY": null
}
]
}
]
}
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| data | object | 返回的数据对象 |
返回参数示例(成功)
{
"code": "0",
"errMsg": "",
"success": true
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28130007",
"errMsg": "device ip/port has exist"
}
| 设备大类/设备小类 | 出入口设备 35 | 道闸设备 36 | 显示设备 37 | 自助设备 38 |
|---|---|---|---|---|
| 出入口LED道闸一体机 16 | 出入口道闸 1 | 诱导屏1 | 反向寻车一体机 0 | |
| 进出口抓拍设备 8 | 停车场道闸 2 | 余位显示2 | ||
| 视频车位检测器 7 | 视频挡车器 3 | 通用屏3 | ||
| 超声波车位检测器 11 | RFID道闸5 | - | ||
| LED抓拍一体机 18 | - | - | ||
| 睿界一体化道闸 19 | - | - | ||
| 室外余位检测相机 20 | - | - |
接口说明
设备修改接口
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/api/evo/device/update
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| deviceManufacturer | 是 | string | 生产厂商,1 - 大华 |
| deviceCategory | 是 | int | 设备大类 出入口设备35、道闸设备36、显示设备37、自助设备38 |
| deviceType | 是 | string | 设备小类,与设备大类的关系见备注 |
| loginType | 是 | string | 登录方式 |
| ownerCode | 是 | string | 所属组织 |
| deviceIp | 是 | string | 设备ip |
| devicePort | 是 | string | 设备端口 |
| loginName | 是 | string | 登录名 |
| loginPassword | 是 | string | 登录密码 rsa加密,加密公钥调用获取公钥获取用于RSA加密 |
| deviceName | 是 | string | 设备名称 |
| devExt | 否 | jsonObject | 设备扩展属性 具体属性见下方 |
| +serverCode | 否 | string | 接入的服务编码 |
| +screenType | 否 | string | 屏幕型号,显示设备时必填 |
| units | 是 | array | 通道列表 具体属性加下方UnitBean |
| +unitType | 是 | string | 单元类型: 1视频单元、14道闸单元 16显示单元 |
| +unitSeq | 是 | int | 单元序号 |
| +unitExt | 否 | jsonObject | 单元扩展属性 出入口设备添加显示通道时需要填写,见UnitExt属性 |
| ++use | 是 | string | 用途: 1诱导屏、2余位屏、3通用屏 |
| +channels | 是 | array | 通道列表 具体属性见ChannelBean |
| ++channelName | 是 | string | 通道名称 |
| ++channelSeq | 是 | int | 通道序号 |
请求参数示例
{
"deviceManufacturer": "大华",
"deviceCategory": 36,
"deviceType": 1,
"loginType": "1",
"ownerCode": "001",
"videoServerCode": "video#local",
"deviceIp": "20.31.21.25",
"devicePort": "37777",
"loginName": "admin",
"loginPassword": "KkZdhvxlbwG3W5NT2xhV+bk1QUJFGZvfBET/3+wNRsrQqwcryhi+8E5JSZQXJBGfgQmlJlHqv8mPio6kZCRHKbngUIlrejq+cirOdkNLbHPOnhBkUhesMLNyGNB4YMqdeiKBRMKnZZtPfBs/rDEZYh0dUfmM7LCa/OP3JWUVGyM=",
"deviceName": "132",
"deviceModel": 4,
"ownerCode": "001",
"devExt": {
"videoServerCode": "video#local"
},
"units": [
{
"unitType": 14,
"channels": [
{
"channelName": "132_道闸通道_1",
"channelSeq": 0,
"gpsX": null,
"gpsY": null
}
]
}
]
}
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| data | object | 返回的数据对象 |
返回参数示例(成功)
{
"code": "0",
"errMsg": "",
"success": true
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "29020035",
"errMsg": "设备不存在"
}
备注
| 设备大类/设备小类 | 出入口设备 35 | 道闸设备 36 | 显示设备 37 | 自助设备 38 |
|---|---|---|---|---|
| 出入口LED道闸一体机 16 | 出入口道闸 1 | 诱导屏1 | 反向寻车一体机 0 | |
| 进出口抓拍设备 8 | 停车场道闸 2 | 余位显示2 | ||
| 视频车位检测器 7 | 视频挡车器 3 | 通用屏3 | ||
| 超声波车位检测器 11 | RFID道闸5 | - | ||
| LED抓拍一体机 18 | - | - | ||
| 睿界一体化道闸 19 | - | - | ||
| 室外余位检测相机 20 | - | - |
接口说明
设备删除接口
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/api/evo/device/delete
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| deviceCodes | 是 | string | 设备ID,多个设备以半角逗号分隔 |
请求参数示例
/evo-apigw/ipms/api/evo/device/delete?deviceCodes=1000274,100027
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| data | object | 返回的数据对象 |
| +successNum | string | 成功删除数量 |
| +failNum | string | 删除失败数量 |
| +failList | array | 删除失败列表 |
返回参数示例(成功)
{
"success": true,
"code": 0,
"errMsg": "",
"data": {
"successNum": "1",
"failNum": "0",
"failList": []
},
"isEncrypt": 0
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "29020035",
"errMsg": "设备不存在"
}
接口说明
可根据设备编码、设备类型、设备在离线、设备名称、设备编码进行设备分页查询
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/device/list
请求Method
GET
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageNum | 是 | int | 页码 |
| pageSize | 是 | int | 页码条数 |
| deviceCategory | 否 | int | 设备大类(5-车牌抓拍设备,14-道闸设备,16-LED设备,20-自助设备,28-地磁网关,29-超声波车检器) |
| ownerCode | 否 | String | 所属组织 |
| deviceType | 否 | int | 设备小类 |
| isOnline | 否 | int | 是否在线 1:在线 0:离线 |
| deviceIp | 否 | String | 设备ip 支持模糊查询 |
| deviceCode | 否 | String | 设备编码 支持模糊查询 |
| deviceName | 否 | String | 设备名称 支持模糊查询 |
| searchKey | 否 | String | 关键字(编码/设备/ip地址) 支持模糊查询 |
请求参数示例
/evo-apigw/ipms/device/list?pageNum=1&pageSize=20&deviceCategory=5&searchKey=&orgName=&ownerCode=&deviceType=&isOnline=&deviceIp=&deviceName=&deviceCode=
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| isEncrypt | int | 是否加密 0:不加密 1:加密 这里加密是指对敏感数据,不影响三方对接,可不关注此参数 |
| data | object | 响应体 |
返回参数data
| 参数 | 类型 | 描述 |
|---|---|---|
| currentPage | int | 当前页码 |
| totalPage | int | 总页码 |
| pageSize | int | 每页条数 |
| totalRows | int | 总条数 |
| pageData | object[] | 响应体 |
返回参数pageData
| 参数 | 类型 | 描述 |
|---|---|---|
| id | long | 设备id |
| deviceCode | String | 设备编码 |
| deviceName | String | 设备名称 |
| deviceCategoryStr | String | 设备名称描述 |
| deviceType | String | 设备类型 |
| deviceTypeStr | String | 设备类型描述 |
| deviceManufacturer | String | 厂商类型 |
| deviceManufacturerStr | String | 厂商类型描述 |
| deviceManufacturerDisguiseType | String | 设备厂商伪装类型 |
| deviceIp | String | 设备ip |
| devicePort | int | 设备端口 |
| ownerCode | String | 组织编码 |
| orgName | String | 组织名称 |
| loginType | String | 设备添加方式 1:ip添加 6:主动注册 |
| loginName | String | 设备用户名 |
| registServiceId | long | 注册服务id |
| videoServerCode | String | 视频服务编码 |
| pictureServerCode | String | 图片服务信息 |
| isOnline | int | 是否在线 0:离线 1:在线 |
| isOnlineStr | String | 在线描述 |
| createDate | 时间戳 | 创建时间 |
| updateDate | 时间戳 | 更新时间 |
| isAddSluice | boolean | 是否添加道闸 |
| registServiceName | String | 注册服务名称 |
| administered | boolean | 是否管理-fales:否,true:是 |
| serialNumber | String | 设备序列号 |
| macNumber | String | mac地址 |
| channelTypes | String | 通道类型 |
| dhMachine | boolean | 是否是大华设备 -fales:否,true:是 |
| encoderUnits | object[] | 编码单元 |
| ledUnits | object[] | 显示设备单元 |
| sluiceUnits | object[] | 道闸通道单元 |
返回参数encoderUnits
| 参数 | 类型 | 描述 |
|---|---|---|
| channelType | int | 通道类型 |
| id | long | 设备id |
| deviceCode | String | 设备编码 |
| unitSeq | int | 单元序号 |
| channelNum | int | 通道数量 |
| assistantStream | int | 辅码流 |
| zeroChnEncode | int | 零通道编码 |
| ptsServiceId | long | pts服务id |
| ptsServiceName | String | pts服务名称 |
| channels | object[] | 编码通道 |
返回参数encoderUnits-channels
| 参数 | 类型 | 描述 |
|---|---|---|
| id | long | 设备id |
| channelName | String | 通道名称 |
| cameraType | int | 相机类型 |
| cameraFunctions | String | 通道类型 |
| channelSn | String | 通道sn |
| channelType | int | 通道类型 |
| type | String | 设备类型 |
返回参数ledUnits
| 参数 | 类型 | 描述 |
|---|---|---|
| channelType | int | 通道类型 |
| id | long | 设备id |
| deviceCode | String | 设备编码 |
| channelNum | int | 通道数量 |
| registServiceId | String | 注册服务id |
| registProxyPort | int | 代理端口 |
| channels | object[] | 显示通道 |
返回参数ledUnits-channels
| 参数 | 类型 | 描述 |
|---|---|---|
| id | long | 设备id |
| channelName | String | 通道名称 |
| ledType | int | LED设备类型 |
| channelSn | String | 通道sn |
| deviceCode | String | 显示设备编码 |
| unitSeq | int | 单元序号 |
| channelSeq | int | 通道序号 |
| type | String | 设备类型 |
返回参数sluiceUnits
| 参数 | 类型 | 描述 |
|---|---|---|
| channelType | int | 通道类型 |
| channelNum | int | 通道数量 |
| registServiceId | String | 注册服务id |
| registProxyPort | int | 代理端口 |
| channels | object[] | 道闸通道 |
返回参数sluiceUnits-channels
| 参数 | 类型 | 描述 |
|---|---|---|
| id | long | 设备id |
| channelName | String | 通道名称 |
| deviceCode | String | 道闸设备编码 |
| channelSn | String | 通道sn |
| unitSeq | int | 单元序号 |
| channelSeq | int | 通道序号 |
返回参数示例
{
"success": true,
"code": 200,
"errMsg": "success",
"data": {
"pageData": [
{
"id": "1639090016116326402",
"deviceCode": "1000094",
"deviceName": "9136",
"deviceCategory": 5,
"deviceCategoryStr": "抓拍相机",
"deviceType": "17",
"deviceTypeStr": "LED抓拍一体机",
"deviceManufacturer": "1",
"deviceManufacturerDisguiseType": "16",
"deviceManufacturerStr": "大华",
"deviceIp": "10.80.9.136",
"devicePort": 40119,
"ownerCode": "001",
"orgName": "根节点",
"loginType": "1",
"loginName": "admin",
"registServiceId": "5",
"videoServerCode": "10.80.4.20",
"pictureServerCode": "pic#local",
"isOnline": 1,
"createDate": 1679624487000,
"updateDate": 1679624487000,
"isOnlineStr": "在线",
"addType": "IP地址",
"encoderUnits": [
{
"channelType": 1,
"id": "1639090016120520706",
"deviceCode": "1000094",
"unitSeq": 0,
"channelNum": 1,
"assistantStream": 1,
"zeroChnEncode": 0,
"ptsServiceId": "5",
"carportType": "1",
"ptsServiceName": "PK_PTS(10.80.4.20:9101)",
"carportTypeStr": "普通车位",
"channels": [
{
"id": "1639090016124715009",
"channelName": "9136_视频通道_1",
"cameraType": "2",
"cameraFunctions": "",
"channelSn": "5420e992f0c8409e895fb5d58e08287e",
"channelType": "3",
"type": "1",
"carports": []
}
]
}
],
"ledUnits": [
{
"channelType": 4,
"channelNum": "1",
"channels": [
{
"id": "1639090017009713154",
"channelName": "9136_显示通道_1",
"defaultText": "",
"ledType": "16",
"deviceCode": "1000096",
"unitSeq": 0,
"channelSeq": 0
}
],
"registServiceId": "2",
"registProxyPort": 61097
}
],
"sluiceUnits": [
{
"channelType": 3,
"channelNum": "1",
"channels": [
{
"id": "1639090016808386561",
"deviceCode": "1000095",
"unitSeq": 0,
"channelSeq": 0,
"channelName": "9136_道闸通道_1",
"stat": 0,
"isSupportLed": 0,
"defaultLedText": ""
}
],
"registServiceId": "1",
"registProxyPort": 61096
}
],
"isAddSluice": false,
"registServiceName": "PK_PTS(10.80.4.20:9101)",
"administered": false,
"serialNumber": "",
"macNumber": "",
"channelTypes": "4,3,1",
"dhMachine": true
}
],
"currentPage": 1,
"totalPage": "1",
"pageSize": 20,
"totalRows": "1"
},
"isEncrypt": 0
}
接口说明
获取全量道闸设备通道信息接口
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/device/sluice/channel
请求Method
GET
数据提交格式
application/json
请求参数
无
请求参数示例
{
https://10.80.4.20/evo-apigw/ipms/device/sluice/channel
}
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| isEncrypt | int | 是否加密 0:不加密 1:加密 这里加密是指对敏感数据,不影响三方对接,可不关注此参数 |
| data | object | 响应体 |
返回参数data
| 参数 | 类型 | 描述 |
|---|---|---|
| channelName | String | 通道名称 |
| channelId | String | 道闸通道id |
返回参数举例说明说明
channelId:1000133$14$0$0
1000133:设备编码
14:道闸设备种类
0:单元编码
0:通道编码
返回参数示例
{
"success": true,
"code": 200,
"errMsg": "success",
"data": [
{
"channelName": "66_道闸通道_1",
"channelId": "1000133$14$0$0"
},
{
"channelName": "1_道闸通道_1",
"channelId": "1000136$14$0$0"
},
{
"channelName": "111_道闸通道_1",
"channelId": "1000142$14$0$0"
},
{
"channelName": "13611_道闸通道_1",
"channelId": "1000151$14$0$0"
}
],
"isEncrypt": 0
}
接口说明
获取可用服务接口,在设备大类选择出入口、道闸、显示设备后,进入基本信息填写页面时调用,接口返回值作为“接入服务器”输入框填写的依据
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/api/evo/device/server/{category}
请求Method
GET
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| category | 是 | int | 设备大类 35 出入口设备,36道闸设备,37显示设备 |
请求参数示例
/evo-apigw/ipms/api/evo/device/server/35
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| data | object | 设备信息,具体见data属性 |
| +options | List | 可选项列表 |
| ++code | int | 可用服务的code |
| ++name | string | 可用服务的显示名称 |
| +selected | string | 默认选择项的code值 |
返回参数示例
{
"code": "0",
"data": {
"options": [
{
"code": "5",
"name": "PK_PTS(10.35.164.30:9101)"
}
],
"selected": "5"
},
"errMsg": "",
"success": true
}
接口说明
获取公钥,设备密码加密需要
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/rsa/getPubKey
请求Method
GET
数据提交格式
application/json
请求参数示例
/evo-apigw/ipms/rsa/getPubKey
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 状态码 |
| data | string | 密钥 |
| success | boolean | 成功失败 |
| errMsg | string | 错误信息 |
| isEncrypt | int | 是否加密显示 |
返回参数示例
{
"success": true,
"code": 200,
"errMsg": "success",
"data": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpkKGTc/Y6eW1R2mn2J3F9bfFvn2ZzpQq3lAVg7SUSbuJPc9J4Sx8amWhEX8SfKhd31Az+InIXz6SlI+1hB0J8zrOp3wv6wzb4xPfpNXLlxadZaD7xcF5Tvxo13FTIFS6nHZsokJRGggn+bi5ApKD6f6TmM/DRKG7Q+5osTkMggQIDAQAB",
"isEncrypt": 0
}
接口说明
可根据道闸通道id控制道闸 注意:该接口远程开闸采用大华开闸协议,仅支持大华道闸设备 注意:该接口为单纯的工具类接口,只做开闸控制,不关联任何其他进出业务逻辑(如人工开闸记录、进出记录的保存)>
前置条件
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
停车场子系统 V1.0.0及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/ipms/subSystem/control/sluice
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| channelId | 是 | string | 道闸通道ID-格式为"设备编号$14$0$0",道闸通道ID调道闸通道信息全量查询接口获取 |
| operateType | 是 | int | 1:先抬杆,直到有车辆经过后自动落下 4:常开,先抬杆,后一直保持抬杆状态,现场遥控不起作用,除非常开恢复 5:常开恢复(即取消常开)有车辆经过后落杆,后面检测到车辆经过,先起后落 |
请求参数示例
{
"channelId":"1000001$14$0$0",
"operateType":1
}
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| errMsg | string | 错误信息 |
| success | boolean | 是否成功 |
| code | int | 状态码 |
| data | object | 响应体 |
返回参数示例
{
"data":true,
"errMsg": "success",
"success": true,
"code": 200
}