基于HTTP的API服务接口说明书

HTTP协议与ScadaCloud通信说明书(V1.0.0.0)ScadaCloudProxy协议说明书(V1.0.0.0)基于HTTP的API服务接口说明书(V1.0.0.0)MinPTechnologyAddress:深圳市龙岗区吉祥路风临国际A1404Tel:[phone]Fax:[phone]HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page2of11目目录录1.SCADACLOUDAPP服务介绍.........................................................................................31.1简介...............................................................................................................................31.2请求参数.......................................................................................................................31.3举例...............................................................................................................................42.服务详解............................................................................................................................52.1注册...............................................................................................................................52.2登陆...............................................................................................................................52.3读取数据点当前值........................................................................................................52.4读取数据点历史数据....................................................................................................62.5设置数据点...................................................................................................................72.6读取未确认事件............................................................................................................72.7确认指定的事件............................................................................................................82.8确认所有的事件............................................................................................................82.9取最大的告警级别........................................................................................................9注意事项...............................................................................................................................10附录A：................................................................................................................................11HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page3of111.ScadaCloudAPP服务介绍1.1简介ScadaCloud为终端提供基于HTTP的接口：登陆，读取数据点的实时数据，读取数据点的历史数据，设置数据点,读取未确认事件，确认事件，确认所有未确认的事件，取当前最大告警级别。设备ScadaCloud服务器HTTP终端设备ScadaCloudM2M与APP通信模型参与ScadaCloudAPP服务的实体有两个：ScadaCloud服务器,它提供基于HTTP的APP服务，链接为；终端设备，如智能手机。在本文档中，时间用距离1970年元月1日0时0分0秒的毫秒数来表示；二进制值用”true”和”false”来表示；多状态变量用由0~9组成的非负整数表示，如0，21，分别表示状态0和状态21；数字量的值用由-，0~9，.表示的浮点数，或科学计数法表示的浮点数。本文档对此约定不再另做说明。API服务的返回值为UTF-8编码的字符串。1.2请求参数使用GET方式时,格式是'=SERVICE&PARAM=VALUE.....各参数的含义如下：参数含义service服务名，当前提供的服务有：login，登陆服务；dpvalue，取数据点当前值；dphistory，取数据点的历史数据；setdp，设置数据点；pendingevents，取未确认事件；ackevents，确认事件；ackpendingevents，确认所有未确认的事件；maxalarmlevel，取账户当前最大的报警级别。PARAM服务的参数；不同的服务参数的个数和含义不一样，详见后续说明。HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page4of111.3举例=login&user=[e-mail]&password=123456它表示用户[e-mail]登陆。HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page5of112.服务详解2.1注册链接格式：=register&username=USERNAME&password=PASSWORD&confirmpassword=PASSWORD参数说明：username表示用户名；password表示密码；confirmpassword表示确认密码返回值格式：如果注册成功，返回字符串“error=OK”，其他字符串表示注册错误。2.2登陆链接格式：=login&username=USERNAME&password=PASSWORD参数说明：username表示登陆用户名；password表示登陆密码。返回值格式：如果登陆成功，返回字符串“OK”，其他字符串表示登陆错误。2.3读取数据点当前值参数格式：=dpvalue&dpxid=DP_XID0&dpxid=DP_XID1……参数说明：dpxid表示数据点的XID值，多个dpxid表示一次取多个数据点的当前值，ScadaCloud对一次取多少个数据点的当前值没有限制，由此带来的带宽问题由用户自己考虑。HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page6of11返回值格式：一、error=Faultstring，表示错误信息。二、count=COUNT&dpxid=DP_XID0&timevalue=TIME0;VALUE0…count=COUNT：COUNT表示实际返回值多少个数据点的值。dpxid=DP_XID0：表示数据点的XID为DP_XID0，随后的timevalue=TIME0;VALUE0数据点的时间和值。比如，count=1&dpxid=DP_001210&timevalue=1396744235937;false,表示返回一个数据点的值，该数据点的xid为DP_001210，值的时间为1396744235937，值为false。假如没有当前值返回，返回”count=0”。2.4读取数据点历史数据参数格式：=dphistory&&dpxid=DP_XID&starttime=TIME0&finaltime=TIME1参数说明：dpxid表示数据点的XID值，一次只能取一个数据点的历史数据。starttime表示开始时间，starttime=0表示从最早的开始时间。finaltiem表示结束时间，finaltime=0表示结束时间为当前时间。Starttime=0&finaltime=0表示取全部的历史数据。一次最多能取1K个历史数据。如果要取大于1K的历史数据，可以多次取，即每次的starttime为上一次的最后的那个历史数据的时间值加1.一次只能取一个数据点的历史数据。返回值格式：一、error=Faultstring，表示错误信息。二、dpxid=DP_XID&count=COUNT&timevalue=TIME0;VALUE0;TIME1;VALUE1……dpxid=DP_XID表示数据点的XID为DP_XID。count=COUNT表示包含多少个历史数据。HTTP协议与ScadaCloud通信说明书(V1.0.0.0)HTTP协议与ScadaCloud通信说明书V1.0.0.0Page7of11timevalue为历史数据的时间和值，时间和值总是成对出现，时间与值用分号隔开。比如，dpxid=DP_001210&count=2&timevalue=13672433