接口规范.doc

接口规范欢迎访问门户网站注册用户,获取最新文档。 11 设计原则 32 HTTP报文格式示例 33 文本数据上传 44 二进制数据上传 6设计原则使用标准HTTP方法实现资源CURD操作;采用json作为API输入输出;以json输出错误信息。HTTP方法描述POST新增资源信息PUT更新资源信息GET查看资源信息DELETE删除资源支持的返回码列表:HTTP返回码含义详细描述200OK在HTTPbody中以json格式指明详细成功或错误信息,例如:{"errno":0,"error":“”}成功、失败指示,主要以errno是否为零来判断。eptable422UnprocessableEntity500InternalServerError503NoservererrorHTTP报文格式示例示例1:示例2:设备(device)文本数据上传HTTP方法POSTURL<device_id>/datapointsHTTP头部api-key:xxxx-ffff-zzzzzHTTP内容有多种数据格式,详细见下面说明请求返回{"errno":0,"error":“”,}说明:可以一次性向设备云上传多个数据流,每个数据流中有可以包括多个数据点。示例程序表示向设备云上数据流temperature和数据流key上传数据。其中temperature数据流有两个数据点,key数据流也有两个数据点。如果某个数据流不存在,,则在增加数据点时,设备云会自动创建一个新的数据流,注意新数据流的streamid不可为空。数据点表示在某个时刻,该数据流的值为多少。其at表示时间,为可选字段。如果为空,则设备云会取当前时间。如果存在其格式必须为"2013-04-22T00:35:43"的形式。数据点中的value表示具体的值,其值为JSON对象,可以为整型、字符串多种类型。如果value部分用双引号括起来,则其在设备云存储为字符串,如果不用双引号括起来,则其表示数字。数据点对应的时间是数据点的标识的一部分,相同时间的两个数据点,后一个会把前一个覆盖。一般如果at部分取空,设备云会取系统时间,精度为毫秒,如果在一条命令中某一个数据流包含多个数据点都没有at字段,会导致设备云只保存了最后一条。为了节省流量,增加数据点支持如下简写方式。在请求的URL中增加type字段,指示所使用的简写方式。目前type支持3,4,5三种情况http://<API_ADDRESS>/devices/<device_id>/datapoints?type=3{“temperature”:,”humidity”:”%”},%。http://<API_ADDRESS>/devices/<device_id>/datapoints?type=4{“temperature”:{“2015-03-22T22:31:12”:}}表示在数据流temperature中加一个数据点,://<API_ADDRESS>/devices