LoRaServer 笔记 2.4 使用 RESTful JSON API

前言

LoRa App Server 提供了两类 API 接口，其中 RESTful JSON API 提供了一个 API console，在AS地址的基础上使用 /api 即可访问，罗列了 API 端点和文档介绍，测试起来非常方便。

小能手最近在学习 ChirpStack 项目，应该是最有影响力的 LoRaWAN 服务器开源项目。它组件丰富，代码可读性强，是个很好的学习资料。更多学习笔记，可点此查看。

1 认证

大部分 API 端点都需要有效的 JWT token 才能使用，它们可以填写在右上角的输入区域。

根据项目介绍，API 的认证机制采用了 JSON web-tokens。

我们可以简单使用 login API 来得到一个短期的 token，也可以使用如下方式得到一个更灵活的 token。

1.1 生成 JWT token

我们需要访问 https://jwt.io ，填入 DATA 以及 密钥 来获得我们的 JWT token。

{
	"iss": "lora-app-server",      // issuer of the claim
	"aud": "lora-app-server",      // audience for which the claim is intended
	"nbf": 1558514186,             // unix time from which the token is valid 
	"exp": 1567808000,             // unix time when the token expires 
	"sub": "user",                 // subject of the claim (an user)
	"username": "admin"            // username the client claims to be
}

其中的 Unix 时间戳，其实有很多工具，例如这个网站，根据北京时间计算之后填入有效的数值。

密钥部分，填入LoRaServer 笔记 1.4 配置运行中的“3.2 配置文件修改”所配置的 jwt_secret。

1.2 填入 JWT token

在 API 界面的右上角填入 token。

2 API 测试

Swagger UI 是一个Restful风格接口的文档在线自动生成和测试的框架。我们可以在API下方直接填入参数，即可快速发出请求。

做个示例。

3 使用 API 进行数据下发

浏览器不能查看数据上行，因此暂且只测试数据下发。

3.1 API 准备

使用 API 为： POST /api/devices/{device_queue_item.dev_eui}/queue

填入 dev_eui 以及 “deviceQueueItem” 的 json 字段。

其中 “data” 字段需要使用 base64 编码，例如借助这个网站，

3.2 节点操作

由于是CLASS A节点，需要先发一条数据上行。对模块进行AT操作，顺利收到下行数据。

[17:29:03.265]发→◇AT+TXA=21,HI
□
[17:29:03.295]收←◆
OK

[17:29:06.807]收←◆+RCV:21,3344

END

---