业务侧接口-RESTfulAPI_20151216剖析.docx

OneNet接入方案与RESTfulAPI接口 欢迎访问设备云门户网站/注册用户，获取最新文档。 版本号 修订日期 修订内容 说明 V1.1 2014.10.30 EDP增加存储数据报文； REST API 增加历史数据查询接口，用于上报数据点，或者上报的同时转发数据点。 V1.1.1 2014/11/3 EDP增加消息类型9，以支持对存储数据的确认。 V1.1.2 2015/01/10 1、修改3.5.3 AB接口，增加获取每个数据流当前值。 2、数据点添加时若无数据流将自动添加数据流。 V1.2.2 2015/01/15 1、 修改3.5.1 ，新增数据流返回uuid，唯一标识该数据流； 2、 修改3.5.1，增加三种复合数据流的添加； 3、 修改触发器相关操作接口。一个触发器可同时监控不同设备的多个数据流。 4、 修改触发器一些条件的设定方式。 V1.2.3 2015/06/18 1、 去掉复合数据流定义 2、 设备批量查看增加device_id 参数 3、 触发器增加title字段 4、 新增触发器批量获取接口 5、 修改key查看输出内容格式 V1.3.0 2015/06/24 1、命令操作，增加响应内容查询 V1.3.1 2015/07/28 1、修改4.6.3，新增数据点抽样和统计 目录 OneNet接入方案与RESTfulAPI接口 1 1 概述 3 2 基于OneNet的应用系统的典型场景 3 3 API资源模型 3 4 REST API 5 4.1 设计原则 5 4.2 HTTP 原始报文格式 6 4.3 设备（device） 6 4.3.1 新增 6 4.3.2 更新 7 4.3.3 查看 8 4.3.4 删除 11 4.4 数据流（datastream） 12 4.4.1 新增 12 4.4.2 更新 12 4.4.3 查看 13 4.4.4 删除 14 4.5 数据点（datapoint） 14 4.5.1 新增 14 4.5.2 更新 16 4.5.3 查看 16 4.5.4 删除 19 4.6 触发器（trigger） 19 4.6.1 新增 19 4.6.2 更新 20 4.6.3 查看 21 4.6.4 删除 22 4.7 API 权限(apikey) 23 4.7.1 新增 23 4.7.2 更新 23 4.7.3 查看 24 4.7.4 删除 25 4.8 二进制数据（bindata） 25 4.8.1 新增 25 4.8.2 查看 26 4.8.3 删除 26 4.9 命令执行（cmd） 26 4.9.1 发送命令 26 4.9.2 查看状态 27 4.9.3 获取响应 27 4.10 其他 28 4.10.1 触发数据内容 28 4.10.2 历史数据查询 29 1 概述 OneNet是中移物联网有限公司基于物联网技术和产业特点打造的开放平台和生态环境，适配各种网络环境和协议类型，支持各类传感器和智能硬件的快速接入和大数据服务，提供丰富的API和应用模板以支持各类行业应用和智能硬件的开发，能够有效降低物联网应用开发和部署成本，满足物联网领域设备连接、协议适配、数据存储、数据安全、大数据分析等平台级服务需求。 中国移动物联网开放平台始终秉承开放合作的态度，为智能硬件创客和创业企业提供硬件社区服务，为中小企业客户物联网应用需求提供数据展现、数据分析和应用生成服务，为重点行业领域/大客户提供行业PaaS服务和定制化开发服务。 是OneNet对外公开的门户，可以通过该门户了解到OneNet的最新进展。 本文档主要描述了OneNet基于HTTP方式向外提供API接口以及这些接口的调用方式、参数说明等等。这些接口按照RESTful的方式向外提供服务。 2 基于OneNet的应用系统的典型场景 设备层：利用平台提供的EDPSDK，实现EDP协议，用于上报业务数据点到OnetNet。若需要实时接收业务层下发的控制命令，需要保持EDP长连接。 业务应用层：若要自定义实现业务平台，可通过HTTP 协议的RESTful API操作OnetNet提供的资源（设备、数据点、命令控制等资源的增删查改）。 适用场景：在充分分析业务数据模型的基础上，认为OneNet提供的设备-数据流-数据点模型适合业务数据存储。优先推荐新业务使用该模式。 3 API资源模型 OneNet HTTPAPI按照RESTful的方式向外提供服务，其资源模型中包含的资源种类有：用户、设备（device）、数据流（datastream）、数据点（datapoint）、触发器（trigger）、API key、命令等。 用户是指通过注册的用户。每个用户可以建立多个项目，每个项目可以添加多个设备。一个设备只能属于一个项目。 一个设备可以产生多