5.了解更多

5.1 更新日志

版本号	发布时间	更新内容
V1.0.0	2023/05/31	适用DASS 3.3.4

5.2 开发者指南

5.2.1简介

DASS是一款用于管理测点采集上传，与实时库建立通信的Web端应用。用户通过DASS应用提供的HTTP接口，可实现二次开发，创建自己的应用。
该文段主要介绍了如何基于DASS应用提供的API进行二次开发，访问相应API需先进行登录注册和添加设备操作。用户根据文段中的步骤说明即可完成并实现DASS相关API的访问，同时提供调用示例以供用户参考。

5.2.2使用步骤

由于DASS是一个多用户、管理多设备的系统，为保证数据访问的安全性与合法性，访问API时要求携带token以及机器设备码进行认证，校验通过后方能响应结果。

5.2.3 注册登录

首先用户需要调用注册接口创建用户，请求体中填入待创建的账号和密码。接口响应code为200表示创建成功，保存已创建的用户信息(账号和密码)。
a. 接口信息

请求类型	端口号	请求地址	描述
POST	8095	/api/mlinkClient/system/user/create	此接口用于用户注册
POST	8095	/api/mlinkClient/system/login	此接口用于用户登录

b. 注册账号
如下图所示，根据请求参数要求调用注册接口，新建访问用户。请求信息体使用JSON格式，填写待注册的用户和密码信息。发送请求，响应code为200表示注册成功。

参数名	类型	说明	是否必填项
login_name	string	用户登录名	是
password1	string	用户密码	是
password2	string	确认密码	是
注册账号代码示意图

c. 用户登录
调用登录接口，请求信息中填写刚才创建的用户信息。接口响应code为200表示登录成功，返回的data中token属性字段，即为访问API时需提供的token，用户可将该token进行保存。
如下图所示，按照请求参数要求调用登录接口，获取token(token属性字段)。请求信息体使用JSON格式，填写刚才注册保存的账号和密码信息。发送请求，响应code为200表示登录成功。

参数名	类型	说明	是否必填项
login_name	string	用户登录名	是
password	string	用户密码	是
用户登录代码示意图

5.2.4 添加设备

调用API时，将登录成功后保存的token加入请求header中。参数名设为“Authorization”， token前需添加“Bearer”加空格符，具体使用方式可参考下文添加设备操作。
a. 接口信息

请求类型	端口号	请求地址	描述
POST	8095	/api/mlinkClient/system/conn/create	添加设备连接接口

b. 添加设备
完成注册登录操作后，已经获取到访问接口所需的token。现在可以使用token访问添加设备接口，绑定需要操作的设备，可获取该设备的设备码，使用设备码即可访问相关API对该设备进行操作。
如下图所示，在ApiPost中调用添加设备接口，在Header中添加登录后返回的token，参数名设置为“Authorization”， token前添加“Bearer”字段，注意Bearer和token之间需要使用空格分隔。

添加设备接口代码示意图-1

如下图所示，根据请求参数要求调用添加设备接口，添加访问设备。请求信息体使用JSON格式，添加待绑定设备的IP端口以及用户名和密码，别名可选填。
请求成功后，可获取到该设备的设备码，即data中的deviceCode字段。也可参考以下提供的curl命令请求示例。

参数名	类型	说明	是否必填项
nick_name	string	连接别名	否
host	string	设备IP地址	是
user_name	string	设备用户名	是
password	string	设备密码	是
port	string	设备端口	是
添加设备接口代码示意图-2

5.2.5 使用示例

完成注册登录并获取到token后，用户还需要调用API添加待操作的设备。添加设备前，需要保证设备服务正常运行，网络访问通畅。接口响应code为200表示设备添加成功，系统会自动为当前设备创建设备码并进行返回，响应体data中的deviceCode属性字段即为设备对应的设备码。
用户调用API时，指定设备码即可访问相应的设备。设备码具体获取方式可参考3.6.4中添加设备操作，具体使用方式可参考下文。
在完成注册、登录、设备添加操作后，我们已经获得了访问接口所需的token和设备码，现在已经可以访问DASS提供的所有接口。
我们通过调用设备运行信息接口来展示如何使用token和设备码来请求设备相关的API，该接口为GET请求，主要是返回设备运行时的一些基础信息，例如网络信息，内存信息，磁盘信息等。
a. 接口信息

请求类型	端口号	请求地址	描述
GET	8095	/api/mlinkClient/monitor/info/	设备运行信息

b. 请求示例
如下图所示，首先将token添加至请求的Header中，还需要修改请求路由中的后缀，使用设备码替换路由中的{deviceCode}字段。发送请求，响应code为200表示请求成功。

请求示例代码示意图