Thingsboard 3.1.0 - REST API_thingsboard接口-优快云博客

本文链接：https://blog.youkuaiyun.com/qgbihc/article/details/108356479

本文详细介绍ThingsBoard平台的API使用方法，包括认证流程、遥测服务的REST API接口及如何通过swagger-ui进行测试。涵盖接口文档地址、认证URL、数据格式、返回内容、X-Authorization头设置等关键信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

接口文档

官方文档地址：https://thingsboard.io/docs/reference/rest-api/
安装完成Thinsboard后，接口的swagger ui http://xxx.xxx.xxx.xxx/swagger-ui.html

认证

URL：http://THINGSBOARD_URL/api/auth/login
数据：{“username”:“tenant@thingsboard.org”, “password”:“tenant”}
JSON格式请求，返回内容如下：

{"token":"$YOUR_JWT_TOKEN", "refreshToken":"$YOUR_JWT_REFRESH_TOKEN"}

认证成功后，使用API请求时，需要在Header中增加X-Authorization：
内容为： “Bearer $YOUR_JWT_TOKEN”

遥测服务

提供了一下REST API获取实体数据。
在这里插入图片描述

测试

可以使用swagger-ui.html，来简单测试：
在这里插入图片描述

点击authorize 设置X-Authorization的值。这个值可以先请求认证后得到。
以Telemetry Controller的getTimeseries进行测试。
URL是/api/plugins/telemetry/{entityType}/{entityId}/values/timeseries{?interval,limit,agg,useStrictDataTypes,keys,startTs,endTs}

entityType：DEVICE
entityId：b0209670-e907-11ea-8ee4-93fde352c8fc
interval：5000
limit：5000
agg：AVG
keys：humidity
startTs：1598951206555
endTs：1598951254674

发送请求后，返回接受到的数据，如下：

{
  "humidity": [
    {
      "ts": 1598951209055,
      "value": 76.3
    },
    ...
    {
      "ts": 1598951254055,
      "value": 73.67999999999999
    }
  ]
}