添加设备

接口说明

设备添加接口

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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
                }
            ]
        }
    ]
}

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
dataobject返回的数据对象

返回参数示例(成功)

{
    "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
超声波车位检测器 11RFID道闸5-
LED抓拍一体机 18--
睿界一体化道闸 19--
室外余位检测相机 20--
修改设备

接口说明

设备修改接口

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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
                }
            ]
        }
    ]
}

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
dataobject返回的数据对象

返回参数示例(成功)

{
    "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
超声波车位检测器 11RFID道闸5-
LED抓拍一体机 18--
睿界一体化道闸 19--
室外余位检测相机 20--
删除设备

接口说明

设备删除接口

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
dataobject返回的数据对象
+successNumstring成功删除数量
+failNumstring删除失败数量
+failListarray删除失败列表

返回参数示例(成功)

{
  "success": true,
  "code": 0,
  "errMsg": "",
  "data": {
    "successNum": "1",
    "failNum": "0",
    "failList": []
  },
  "isEncrypt": 0
}

返回参数示例(失败)


{
  "success": false,
  "data": {},
  "code": "29020035",
  "errMsg": "设备不存在"
}
设备列表查询

接口说明

可根据设备编码、设备类型、设备在离线、设备名称、设备编码进行设备分页查询

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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=

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
isEncryptint是否加密 0:不加密 1:加密 这里加密是指对敏感数据,不影响三方对接,可不关注此参数
dataobject响应体

返回参数data

参数类型描述
currentPageint当前页码
totalPageint总页码
pageSizeint每页条数
totalRowsint总条数
pageDataobject[]响应体

返回参数pageData

参数类型描述
idlong设备id
deviceCodeString设备编码
deviceNameString设备名称
deviceCategoryStrString设备名称描述
deviceTypeString设备类型
deviceTypeStrString设备类型描述
deviceManufacturerString厂商类型
deviceManufacturerStrString厂商类型描述
deviceManufacturerDisguiseTypeString设备厂商伪装类型
deviceIpString设备ip
devicePortint设备端口
ownerCodeString组织编码
orgNameString组织名称
loginTypeString设备添加方式 1:ip添加 6:主动注册
loginNameString设备用户名
registServiceIdlong注册服务id
videoServerCodeString视频服务编码
pictureServerCodeString图片服务信息
isOnlineint是否在线 0:离线 1:在线
isOnlineStrString在线描述
createDate时间戳创建时间
updateDate时间戳更新时间
isAddSluiceboolean是否添加道闸
registServiceNameString注册服务名称
administeredboolean是否管理-fales:否,true:是
serialNumberString设备序列号
macNumberStringmac地址
channelTypesString通道类型
dhMachineboolean是否是大华设备 -fales:否,true:是
encoderUnitsobject[]编码单元
ledUnitsobject[]显示设备单元
sluiceUnitsobject[]道闸通道单元

返回参数encoderUnits

参数类型描述
channelTypeint通道类型
idlong设备id
deviceCodeString设备编码
unitSeqint单元序号
channelNumint通道数量
assistantStreamint辅码流
zeroChnEncodeint零通道编码
ptsServiceIdlongpts服务id
ptsServiceNameStringpts服务名称
channelsobject[]编码通道

返回参数encoderUnits-channels

参数类型描述
idlong设备id
channelNameString通道名称
cameraTypeint相机类型
cameraFunctionsString通道类型
channelSnString通道sn
channelTypeint通道类型
typeString设备类型

返回参数ledUnits

参数类型描述
channelTypeint通道类型
idlong设备id
deviceCodeString设备编码
channelNumint通道数量
registServiceIdString注册服务id
registProxyPortint代理端口
channelsobject[]显示通道

返回参数ledUnits-channels

参数类型描述
idlong设备id
channelNameString通道名称
ledTypeintLED设备类型
channelSnString通道sn
deviceCodeString显示设备编码
unitSeqint单元序号
channelSeqint通道序号
typeString设备类型

返回参数sluiceUnits

参数类型描述
channelTypeint通道类型
channelNumint通道数量
registServiceIdString注册服务id
registProxyPortint代理端口
channelsobject[]道闸通道

返回参数sluiceUnits-channels

参数类型描述
idlong设备id
channelNameString通道名称
deviceCodeString道闸设备编码
channelSnString通道sn
unitSeqint单元序号
channelSeqint通道序号

返回参数示例

{
  "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
}

道闸通道信息全量查询

接口说明

获取全量道闸设备通道信息接口

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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
}

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
isEncryptint是否加密 0:不加密 1:加密 这里加密是指对敏感数据,不影响三方对接,可不关注此参数
dataobject响应体

返回参数data

参数类型描述
channelNameString通道名称
channelIdString道闸通道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
}

查询接入服务信息

接口说明

获取可用服务接口,在设备大类选择出入口、道闸、显示设备后,进入基本信息填写页面时调用,接口返回值作为“接入服务器”输入框填写的依据

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
dataobject设备信息,具体见data属性
+optionsList可选项列表
++codeint可用服务的code
++namestring可用服务的显示名称
+selectedstring默认选择项的code值

返回参数示例

{
  "code": "0",
  "data": {
    "options": [
      {
        "code": "5",
        "name": "PK_PTS(10.35.164.30:9101)"
      }
    ],
    "selected": "5"
  },
  "errMsg": "",
  "success": true
}
获取公钥

接口说明

获取公钥,设备密码加密需要

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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

返回参数

参数名类型说明
codeint状态码
datastring密钥
successboolean成功失败
errMsgstring错误信息
isEncryptint是否加密显示

返回参数示例

{
  "success": true,
  "code": 200,
  "errMsg": "success",
  "data": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpkKGTc/Y6eW1R2mn2J3F9bfFvn2ZzpQq3lAVg7SUSbuJPc9J4Sx8amWhEX8SfKhd31Az+InIXz6SlI+1hB0J8zrOp3wv6wzb4xPfpNXLlxadZaD7xcF5Tvxo13FTIFS6nHZsokJRGggn+bi5ApKD6f6TmM/DRKG7Q+5osTkMggQIDAQAB",
  "isEncrypt": 0
}
道闸控制

接口说明

可根据道闸通道id控制道闸 注意:该接口远程开闸采用大华开闸协议,仅支持大华道闸设备 注意:该接口为单纯的工具类接口,只做开闸控制,不关联任何其他进出业务逻辑(如人工开闸记录、进出记录的保存)>

前置条件

请求头设置Authorization字段

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台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是int1:先抬杆,直到有车辆经过后自动落下
4:常开,先抬杆,后一直保持抬杆状态,现场遥控不起作用,除非常开恢复
5:常开恢复(即取消常开)有车辆经过后落杆,后面检测到车辆经过,先起后落

请求参数示例

{
    "channelId":"1000001$14$0$0",
    "operateType":1
}

返回参数

参数类型描述
errMsgstring错误信息
successboolean是否成功
codeint状态码
dataobject响应体

返回参数示例

{
    "data":true,
    "errMsg": "success",
    "success": true,
    "code": 200
}