当前位置：文档之家 › 业务侧接口-RESTfulAPI_20151216

业务侧接口-RESTfulAPI_20151216

  • 格式：docx
  • 大小：150.44 KB
  • 文档页数：31

OneNet接入方案与RESTfulAPI接口 欢迎访问设备云门户网站http://open.iot.10086.cn/注册用户，获取最新文档。 版本号 修订日期 修订内容 说明

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 更新 ................................................................................................................. 17 4.5.3 查看 ................................................................................................................. 17 4.5.4 删除 ................................................................................................................. 20 4.6 触发器（trigger） .................................................................................................. 20 4.6.1 新增 ................................................................................................................. 20 4.6.2 更新 ................................................................................................................. 22 4.6.3 查看 ................................................................................................................. 22 4.6.4 删除 ................................................................................................................. 24 4.7 API 权限(apikey)..................................................................................................... 24 4.7.1 新增 ................................................................................................................. 24 4.7.2 更新 ................................................................................................................. 25 4.7.3 查看 ................................................................................................................. 25 4.7.4 删除 ................................................................................................................. 26 4.8 二进制数据（bindata） ........................................................................................ 27 4.8.1 新增 ................................................................................................................. 27 4.8.2 查看 ................................................................................................................. 27 4.8.3 删除 ................................................................................................................. 28 4.9 命令执行（cmd） .................................................................................................. 28 4.9.1 发送命令 ......................................................................................................... 28 4.9.2 查看状态 ......................................................................................................... 29 4.9.3 获取响应 ......................................................................................................... 29 4.10 其他 ......................................................................................................................... 30 4.10.1 触发数据内容 ................................................................................................. 30 4.10.2 历史数据查询 ................................................................................................. 30

合集下载

使用RESTful API进行前后端交互

使用RESTful API进行前后端交互

使用RESTful API进行前后端交互 随着互联网技术的不断发展和普及，前后端分离的开发模式逐渐成为主流。在这种模式下，前端和后端通过API进行交互，使系统更灵活、可维护性更高。而RESTful API作为一种设计规范，使得前后端交互更加简单、有效。本文将探讨使用RESTful API进行前后端交互的主要原则和步骤。

1. RESTful API的原则 RESTful API是一种基于HTTP协议的设计规范，其主要原则有以下几点： 1.1. 资源以URL进行访问 RESTful API的核心是资源。每个资源都有一个唯一的URL来标识它，通过访问这个URL可以对资源进行操作。例如，对于一个博客系统，对于某篇博文的操作可以通过访问像“/blog/articles/1”的URL来完成。

1.2. 使用HTTP动词操作资源 RESTful API使用HTTP的动词来操作资源。常见的HTTP动词有GET、POST、PUT、DELETE等。GET用于获取资源，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。通过合理使用这些HTTP动词，可以明确表达对资源的操作，使接口更加规范和易于理解。

1.3. 使用HTTP状态码传递操作结果 RESTful API使用HTTP状态码来传递操作结果。200表示成功，201表示创建成功，204表示删除成功，400表示请求参数错误，401表示未授权，403表示禁止访问，404表示资源不存在等。通过合理使用这些状态码，可以告知前端发生了什么情况，进而前端可以根据状态码做出相应的表现。

2. 使用RESTful API进行前后端交互的步骤 使用RESTful API进行前后端交互的步骤主要包括以下几点： 2.1. 定义API接口 前后端需要一起定义好API接口，明确每个接口的URL、参数、返回结果等。接口设计要符合RESTful API的原则，使得接口规范、易于理解。

通过RESTfulAPI实现跨平台数据交互

通过RESTfulAPI实现跨平台数据交互

通过RESTfulAPI实现跨平台数据交互RESTful API，简称REST API，是一种轻量级的网络服务协议。

它采用HTTP协议，通过URL来访问网络上的资源，并使用HTTP请求方式对资源进行操作和传输数据。

RESTful API实现了数据交互和资源共享的标准化，其设计简单、易于扩展，被广泛应用于跨平台数据交互、互联网上的各种Web应用和移动应用的开发中。

跨平台数据交互数据交互在现代IT技术中扮演着至关重要的角色，它不仅仅是计算机应用的核心，也是移动互联网时代的基础设施。

在一个多样化的IT环境中，跨平台数据交互是一个关键问题。

不同的平台和设备中，数据存储的方式、数据格式和数据标准都存在差异，这使得数据的共享和交流变得非常困难。

通过RESTful API，可以解决这个问题，它为数据交互提供了一个标准，使得不同平台之间的数据交互变得非常简单和可行。

RESTful API的设计极为简单，它采用HTTP请求方法来访问网络资源，使用URL来定位资源，借助HTTP状态码来表示操作结果，以及使用HTTP头信息来表示所要传递的数据。

这个设计使得RESTful API可以在不同平台和设备之间进行数据交互，非常适合跨平台数据交互。

实现跨平台数据交互的过程需要遵循一定的规范和标准。

首先，需要确定要交换的数据类型和格式，然后需要明确API的访问方式和授权方式，接下来需要设计合适的API接口，并在服务器端、客户端和应用程序之间进行接口的开发和测试。

最后，需要对交互的数据进行标准化和验证，以确保数据交互的可靠性和稳定性。

实现RESTful API跨平台数据交互的具体步骤如下：1. 确定要交换的数据类型和格式数据格式和类型是数据交互的基础，必须在API设计之前就明确确定。

在不同的平台和设备中，可能使用不同的数据存储方式和数据格式，因此需要针对不同平台进行适配。

常见的数据格式包括JSON、XML、YAML等，其中JSON在现代互联网应用中非常流行，因为它具有良好的可读性和易于解析的特点。

Python中的RESTfulAPI

Python中的RESTfulAPI

Python中的RESTfulAPIPython中的RESTful API简介：RESTful API是一种设计风格，用于构建可伸缩的、可扩展的网络应用程序接口。

在Python中，我们可以使用各种工具和框架来创建和使用RESTful API。

本文将介绍RESTful API的基本概念、Python中常用的RESTful API框架以及实际应用案例。

一、RESTful API的基本概念REST（Representational State Transfer）是一种基于HTTP协议的架构风格，用于构建分布式的超媒体系统。

RESTful API是符合REST原则的API设计，具有以下特点：1.无状态性：每一次请求都可以独立完成，服务器不需要保存客户端的状态信息。

2.资源导向：将系统的功能抽象为资源，使用URI（统一资源标识符）标识资源。

3.统一接口：使用通用的HTTP方法（GET、POST、PUT、DELETE等）对资源进行操作。

4.支持多种数据格式：RESTful API可以使用多种数据格式（如JSON、XML等）进行数据交换。

二、Python中常用的RESTful API框架在Python中，有多个RESTful API框架可供选择，下面介绍其中几个常用的框架：1.Flask-RESTful：Flask是一个轻量级的Web框架，而Flask-RESTful则是在Flask的基础上扩展出来的RESTful API框架。

它提供了简单易用的API构建工具，并支持路由、请求参数解析、错误处理等功能。

2.Django REST framework：Django是一个强大的Web框架，而Django REST framework则是在Django的基础上构建的RESTful API框架。

它提供了丰富的功能，包括序列化、身份验证、权限控制等，并支持多种数据存储后端。

3.Tornado：Tornado是一个异步的Web框架，它具有高性能和可伸缩性的特点。

resful api接口定义规则

resful api接口定义规则

resful api接口定义规则
RESTful API 是一种设计风格，用于构建基于 HTTP 协议的网络应用程序接口。

它有一些定义规则，包括以下几点：
1. 使用 HTTP 方法来定义操作，RESTful API 使用 HTTP 方法来表示对资源的不同操作。

常用的 HTTP 方法包括 GET（获取资源）、POST（创建资源）、PUT（更新资源）、DELETE（删除资源）等。

2. 使用 URI 来标识资源，每个资源都有一个唯一的标识符，称为 URI（统一资源标识符）。

在 RESTful API 中，URI 应该清晰地表达资源的层级结构和关系，以便客户端能够通过 URI 定位到所需的资源。

3. 使用状态码来表示结果，RESTful API 使用标准的 HTTP 状态码来表示操作的结果，如 200（成功）、201（已创建）、400（错误的请求）、404（未找到）等。

4. 使用 JSON 或 XML 来传输数据，RESTful API 通常使用JSON 或 XML 格式来传输数据，这两种格式都能很好地表示数据结
构，并且易于解析和处理。

5. 无状态性，RESTful API 是无状态的，即每个请求都应该包含足够的信息，使得服务器能够理解并处理该请求，而不需要依赖之前的请求状态。

6. 使用超媒体作为应用状态的引擎（HATEOAS），这是RESTful API 的一个重要概念，即客户端通过服务器返回的超媒体信息来发现和使用可用的操作。

总的来说，RESTful API 的设计规则旨在使接口清晰、易于理解和使用，同时也能够提供灵活性和扩展性。

这些规则有助于开发人员构建出易于维护和扩展的 API，并且能够为客户端提供良好的用户体验。