下载API工具

点击右侧链接下载Postman-win64-10.21.0-Setup.exe

../../_images/155.png

HTTP接口

上下载配置：POST http://{IP}:8090/v1/conf
召唤数据：GET http://{IP}:8090/v1/callData
召唤设备状态：GET http://{IP}:8090/v1/callEquipStatus
召唤北向平台状态：GET http://{IP}:8090/v1/callDataPlatformStatus
召唤日志：GET http://{IP}:8090/v1/callLog
设备采集启停控制：POST http://{IP}:8090/v1/devsCmd
写数据：POST http://{IP}:8090/v1/writeData

测试网关的IP是192.168.1.167

一、上载配置

请求地址：- GET http://192.168.1.167:8090/v1/conf

请求参数（raw——–JSON）

（1）命令

		//上载配置不需要命令参数

（2）响应

{
    "baseConfig": {
        "equips": [
            {
                "collectConf": {
                    "abnormalMax": 3,
                    "allowTimeOut": {
                        "read": 2000,
                        "write": 2000
                    },
                    "intervalTime_ms": 1,
                    "isBlockRead": true,
                    "isBlockWrite": true,
                    "isRunCmd": true,
                    "pollingCycleTime_ms": 500
                },
                "conclude": {
                    "isUse": false,
                    "libName": ""
                },
                "equipId": "dev101",
                "equipName": "dev101",
                "interfaceParams": {
                    "link": "192.168.18.21:102",
                    "physicalInterface": "eth0"
                },
                "properties": [
                    {
                        "authority": "RW",
                        "dataAddress": "DB10.DBD10[50]",
                        "dataArea": "",
                        "dataDesc": "dev101_b1",
                        "dataDisplay": "string",
                        "dataName": "dev101_b1",
                        "dataUnit": "n",
                        "driveFlag": {
                            "isConclude_R": true,
                            "isConclude_W": true
                        },
                        "id": "dev101_b1",
                        "offset": "0",
                        "proportion": "1"
                    }
                ],
                "protocol": {
                    "libName": "Siemens_S7",
                    "params": {
                        "linkPar": "1"
                    }
                }
            }
        ],
        "gateway": "fj_502",
        "id": "fj00000001",
        "siteEn": "0001",
        "type": "S_DataInfo"
    },
    "mapSvrConfig": [
    ],
    "taskConfig": {
        "PlatformPar": [
        ],
        "gateway": "fj_502",
        "id": "fj00000001",
        "tasks": [
        ],
        "type": "N_Task"
    }
}

二、下载配置

（1）命令

（2）响应

三、召唤数据

请求地址：- GET http://192.168.1.167:8090/v1/callData

(1)请求参数（raw——–JSON）

//（1）命令

{
    "type": "S_Control",
    "cmd": "callData",
    "messageId": "123",
    "param": {
        "equipId": "dev101"
    }
}

//（2）响应

{
    "cmd": "callData", 
    "data": {
        "data": [
            {
                "dataId": "dev101_dev101_b1", 
                "dataName": "dev101_b1", 
                "quality": "good", 
                "timeStamp": "2023-09-25 15:29:14.921", 
                "value": "abcdefghijklmnopqrstuvwxyz"
            }
        ], 
        "equips": [
            {
                "dataIdQualityNum": {
                    "bad": 0, 
                    "good": 1
                }, 
                "equipId": "dev101", 
                "state": "good"
            }
        ], 
        "type": "N_data"
    }, 
    "messageId": "123", 
    "msg": "召唤设备数据", 
    "respond": "succeed", 
    "type": "S_Control"
}

四、召唤设备状态

请求地址：- GET http://192.168.1.167:8090/v1/callEquipSatus

(1)请求参数（raw——–JSON）

（1）命令

{
    "type": "S_Control",
    "cmd": "callEquipSatus",
    "messageId": "123",
    "param": {
        "equipId": "dev101"
    }
}

（2）响应

{
    "cmd": "callEquipStatus", 
    "data": [
        {
            "dataIdQualityNum": {
                "bad": 0, 
                "good": 1
            }, 
            "equipId": "dev101", 
            "isStart": true, 
            "state": "good"
        }
    ], 
    "messageId": "123", 
    "msg": "召唤设备状态", 
    "respond": "succeed", 
    "type": "S_Control"
}

五、召唤北向平台状态

请求地址：- GET http://192.168.1.167:8090/v1/callDataPlatformStatus

(1)请求参数（raw——–JSON）

（1）命令

{
    "type": "S_Control",
    "cmd": "callEquipSatus",
    "messageId": "123",
    "param": {
        "equipId": "dev101"
    }
}

（2）响应

{
    "cmd": "callDataPlatformStatus", 
    "data": [ ], 
    "messageId": "123", 
    "msg": "召唤数据平台连接状态", 
    "respond": "succeed", 
    "type": "S_Control"
}

五、设备采集启停控制

请求地址：- POST http://192.168.1.167:8090/v1/devsCmd

(1)请求参数（raw——–JSON）

（1）命令

{
	"type": "S_Control",
	"cmd": "devsCmd",
	"messageId":"123",
	"param":{
		"equipId":"dev101",
        "isStart":true
	}
}

（2）响应

{
    "type":"S_Control",
	"cmd": "devsCmd",
	"messageId":"123",
	"respond":"succeed",//枚举 succeed ,fail, overTime
	"msg":"设备写值成功",//中文提示，可以忽略
	"data":{}
}

六、写数据

请求地址：- POST http://192.168.1.167:8090/v1/writeData

请求参数（raw——–JSON）

（1）命令

{
    "type": "S_Control",
    "cmd": "writeData",
    "messageId": "123",
   ""param":{
		"equipId":"dev101",
		"id":"b1",
		"value":"20",
		"dataDisplay":"int16"
	}
}

（2）响应

{
    "cmd": "writeData", 
    "data": [ ], 
    "messageId": "123", 
    "msg": "设备写值成功", 
    "respond": "succeed", 
    "type": "S_Control"
}