CN104618252A

CN104618252A - 一种路由器的接口体系的构建方法

Info

Publication number: CN104618252A
Application number: CN201510094691.0A
Authority: CN
Inventors: 乔龙飞
Original assignee: BEIJING JIKEJIKE TECHNOLOGY Co Ltd
Current assignee: BEIJING JIKEJIKE TECHNOLOGY Co Ltd
Priority date: 2015-03-03
Filing date: 2015-03-03
Publication date: 2015-05-13

Abstract

本发明公开一种路由器的接口体系的构建方法，其能够使得接口体系清晰、便于进行功能扩展、便于调用者使用、接口在本地和远程皆可调用、***安全性强。该方法包括：构造基于命名空间的接口体系、构造消息通道、配置权限认证、配置输入输出参数格式。

Description

一种路由器的接口体系的构建方法

技术领域

本发明属于路由器的技术领域，具体地涉及一种路由器的接口体系的构建方法。

背景技术

传统的路由器，其内部各种功能通过直接调用指令来完成，各种不同的功能有不同的实现方式、不同的参数形式和调用方式，功能划分不清晰。接口没有一个统一的接口输入输出框架，不便于进行功能扩展，也不便于调用者使用。

另一方面，传统的路由器的接口只能在本地调用，只有本地网络中才能对路由器进行操作，而无法远程进行信息查看和参数设置，可扩展性较差。

再一方面，传统的路由器的接口权限控制(权限控制指对不通的调用者，限制他们接口调用的范围，保证***的安全性和可控性)较为简单，只要有后台密码，就可以调用所有接口，而无法进行权限划分，比如某些调用者只能查看信息，某些调用者可以有更多高权限的功能，这样造成路由器使用时安全性较低。

发明内容

本发明要解决的技术解决问题是：克服现有技术的不足，提供一种路由器的接口体系的构建方法，其能够使得接口体系清晰、便于进行功能扩展、便于调用者使用、接口在本地和远程皆可调用、***安全性强。

本发明的技术解决方案是：这种路由器的接口体系的构建方法，该方法包括：构造基于命名空间的接口体系、构造消息通道、配置权限认证、配置输入输出参数格式；

在构造基于命名空间的接口体系中，路由器对外提供的API方法由嵌入式动态语言lua编写，以namespace命名空间来组织，各级空间以点号分割，命名空间分为三个层次，权限范围逐步变小，下面的层次隶属于上一层，是上一层功能的子集；

在构造消息通道中，路由器端作为一个消息接收者同cloud-client对接，服务器端则作为一个业务***同cloud-server通信，服务器端采用同步调用接口同cloud服务器进行通信，API的接口调用路径包括本地和服务器端；

在配置权限认证中，API调用者使用预先分配的app_key和app_secret来对请求签名，服务器端直接调用openapi.hiwifi.com，客户端通过openapi.hiwifi.com和指定路由器绑定以后，通过请求域名client.openapi.hiwifi.com直接调用被绑定路由器里面的接口。

本发明按照命名空间划分出具体的接口所属***，使得接口体系清晰；本发明通过构造消息通道，使得云服务器端和路由器端同时调用，而无需做任何切换，实现透明的调用效果，便于进行功能扩展、便于调用者使用、接口在本地和远程皆可调用；本发明在配置权限认证中实现了权限授权和校验功能，可以对不同的使用者授予不同的权限，保证***的安全性和可控性。

附图说明

图1示出了根据本发明的API的namespace的结构设计。

图2示出了根据本发明的加密消息通道的一个优选实施例。

图3示出了根据本发明的openapi调用路径。

图4示出了根据本发明的远程调用API框架。

具体实施方式

这种路由器的接口体系的构建方法，该方法包括：构造基于命名空间(命名空间是一种范围划分方法，将相关的事务合并到同一个分类中)的接口体系、构造消息通道、配置权限认证、配置输入输出参数格式；

在构造消息通道中，路由器端作为一个消息接收者同cloud-client对接，服务器端则作为一个业务***同cloud-server通信，服务器端采用同步调用接口同cloud服务器(指路由器开发厂商所拥有的，部署在机房的服务器，与路由器端是相对的概念)进行通信，API的接口调用路径包括本地和服务器端；

优选地，在构造基于命名空间的接口体系中，接口通过lua的module模块来进行组织，相关的接口封装在同一个module模块中。

优选地，在配置权限认证中，通过请求域名client.openapi.hiwifi.com直接调用被绑定路由器里面的接口成功以后，openapi.hiwifi.com返回一个client_secret，调用client.openapi.hiwifi.com用此client_secret来请求签名。

优选地，在配置输入输出参数格式中，输入参数格式为输入调用者的id、调用者申请的名字、调用的设备MAC地址、调用的方法名、调用的接口所需要的参数，输出参数格式为输出路由器返回代码、路由器返回文字描述、路由器对应接口返回数据、平台返回代码、平台返回文字描述、平台返回其他数据。

优选地，在配置输入输出参数格式中，API框架接口调用格式使用POST方式提交JSON(JSON(JavaScript Object Notation)是一种轻量级的数据交换格式。基于JavaScript的一个子集。JSON采用完全独立于语言的文本格式，性使JSON成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，网络传输速度快)格式的请求数据，HTTP header中的Content-Type设为application/json，action包含绑定、解除绑定、调用API、获取状态；加密认证通过对POST的数据算出一个校验码sign并作为一个参数。

以下给出一个具体实施例。

这种路由器的接口体系的构建方法，该方法包括：构造基于命名空间的接口体系、构造消息通道、配置权限认证、配置输入输出参数格式。

1、基于命名空间的接口体系

路由器对外提供的API方法由嵌入式动态语言lua编写。为了更合理的分配和管理接口，方法以namespace命名空间来组织，各级空间以点号分割，如system.os.restart，其结构如图1所示。命名空间总共分为三个层次，权限范围逐步变小。下面的层次隶属于上一层，是上一层功能的子集。接口通过lua的module模块来进行组织，相关的接口封装在同一个module中，比如上述restart接口属于openapi.system.os这个module。

2、消息通道

API框架***在基于极路由的加密消息通道实现，加密消息通道如图2所示。在路由器端作为一个消息接收者同cloud-client对接，服务器端则作为一个业务***同cloud-server通信，为了提高接口调用速度，服务器端采用同步调用接口同cloud服务器进行通信。API的接口调用路径有两个，本地和服务器端，其结构如图3所示。

3、权限认证

为了调用API，调用者需要使用预先分配的app_key和app_secret来对请求签名。

该框架同时支持服务器和客户端调用，服务器直接调用openapi.hiwifi.com。客户端通过openapi.hiwifi.com和特定路由器绑定以后，可通过请求域名client.openapi.hiwifi.com直接调用被绑定路由器里面的接口。绑定成功以后openapi.hiwifi.com返回一个client_secret,调用client.openapi.hiwifi.com需要用此client_secret来请求签名。在路由器的局域网内，client.openapi.hiwifi.com这个域名会被拦截到路由器本身，因此客户端只要访问client.openapi.hiwifi.com就可以直接访问到路由器而不经过外网，这样可以提高接口调用速度。

4、输入输出参数格式

API框架接口调用格式如下:

https://openapi.hiwifi.com/{action}？sign＝{sign}

使用POST方式提交JSON格式的请求数据，HTTP header中的Content-Type需要设为application/json，action包含bind(绑定)、unbind(解除绑定)、call(调用api)、status(获取状态)。

加密认证通过对POST的数据算出一个校验码sign并作为一个参数，算法如下：

$str＝$action.$jsonbody.$app_secret；

$sign＝md5($str)；

app_id是每个外部调用者的编号，app_secret是每个外部调用者的密匙。

为了方便管理和调用，框架设计了一个统一的输入输出数据格式，其中输入参数格式如下：

输出参数格式如下：

本发明在实际部署时的***框架如图4所示。

对***的进一步的说明如下：

1.***对路由器中的所有功能按照命名空间的方式进行组织。

2.路由器对外提供本地和远程调用的接口，只要调用者和被调用的设备都在线，即可实现调用的效果。

3.***内部包含一个权限认证模块，所有对接口的调用都需要包含认证信息，路由器本地对调用者的合法性和权限进行校验，对不合法的或者超出权限范围的调用直接返回相应错误信息。

本发明的有益效果体现在：

1.接口体系的清晰：采用本方案使得路由器整体接口构成清晰易懂，便于对***所具有的功能进行整体规划和调整。

2.功能的可扩展性：采用本方案，新增一个功能模块式只需要对应的新增加一个命名空间中的子空间，即可将接口融入原有的体系中。

3.接口调用的便捷性和易用性：采用本方案，输入输出数据格式都是标准化的，适用于多种语言和多种平台，可以跨平台调用，同时提供远程调用的机制，可以通过网络远程对路由器进行信息查看和远程控制。

4.权限认证的灵活性和安装性：采用本方案，可以明确划分不通调用者的调用权限，对权限进行灵活且严格的控制，防止传统路由器中一旦密码丢失则所有接口都暴露在调用者面前的问题，不通的调用者只能在权限范围内活动。保证了***的安全性。

以上所述，仅是本发明的较佳实施例，并非对本发明作任何形式上的限制，凡是依据本发明的技术实质对以上实施例所作的任何简单修改、等同变化与修饰，均仍属本发明技术方案的保护范围。

Claims

1.一种路由器的接口体系的构建方法，其特征在于：该方法包括：构造基于命名空间的接口体系、构造消息通道、配置权限认证、配置输入输出参数格式；

2.根据权利要求1所述的路由器的接口体系的构建方法，其特征在于：在构造基于命名空间的接口体系中，接口通过lua的module模块来进行组织，相关的接口封装在同一个module模块中。

3.根据权利要求2所述的路由器的接口体系的构建方法，其特征在于：在配置权限认证中，通过请求域名client.openapi.hiwifi.com直接调用被绑定路由器里面的接口成功以后，openapi.hiwifi.com返回一个client_secret，调用client.openapi.hiwifi.com用此client_secret来请求签名。

4.根据权利要求3所述的路由器的接口体系的构建方法，其特征在于：在配置输入输出参数格式中，输入参数格式为输入调用者的id、调用者申请的名字、调用的设备MAC地址、调用的方法名、调用的接口所需要的参数，输出参数格式为输出路由器返回代码、路由器返回文字描述、路由器对应接口返回的数据、平台返回代码、平台返回文字描述、平台返回其他数据。

5.根据权利要求3所述的路由器的接口体系的构建方法，其特征在于：在配置输入输出参数格式中，API框架接口调用格式使用POST方式提交json格式的请求数据，HTTP header中的Content-Type设为application/json，action包含绑定、解除绑定、调用API、获取状态；加密认证通过对POST的数据算出一个校验码sign并作为一个参数。