ThingsPanel-1.1.6
  1. ✨设备调用
ThingsPanel-1.1.6
  • 用户认证
    • 用户登录
      POST
    • 邮箱注册租户
      POST
    • 退出登录
      GET
    • 刷新令牌
      GET
    • 【租户】获取邮箱验证码
      GET
  • 密码管理
    • 更新个人密码
      POST
    • 【租户】重置密码(通过邮箱验证码)
      POST
  • 个人信息管理
    • 用户个人信息查询
      GET
    • 修改个人信息
      POST
    • 【租户】获取租户ID
      GET
    • 用户详情
      GET
  • 权限控制
    • 获取菜单
      GET
  • 系统类
    • SSE
      • 获取系统通知
    • 获取系统秒级时间戳
      GET
    • 健康检测
      GET
    • 获取系统版本
      GET
  • 租户/用户管理
    • 分页获取租户/用户列表
      GET
    • 修改租户/用户信息
      PUT
    • 创建新租户/用户
      POST
    • 获取租户/用户信息
      GET
    • 删除租户/用户
      DELETE
    • 【超管】进入租户
      POST
  • 数据总览
    • 设备总数查询
    • 【超管】设备总数/激活数
    • 【超管】系统租户信息统计
    • 【租户】设备汇总
    • 【租户】用户信息汇总
    • 【租户】遥测消息数量(约等于)
    • 【租户】设备在线离线趋势查询
    • 【超管】获取当前系统指标(CPU、内存、磁盘)
    • 【超管】获取系统指标历史数据(CPU、内存、磁盘)
    • 【租户】当前告警状态的设备数量
  • ✨设备调用
    • 设备动态认证(一型一密)
      POST
  • 【租户】产品
    • 产品管理
      • 设备预注册
        • 生成预注册设备
        • 预注册设备列表查询
        • 导出预注册设备凭证
      • 创建产品
      • 产品分页查询
      • 更新产品
      • 删除产品
    • 升级包管理
      • 创建升级包
      • 升级包分页查询
      • 更新升级包
      • 删除升级包
    • OTA升级
      • 创建升级任务
      • 升级任务列表分页查询
      • 升级任务详情列表分页查询
      • 更新升级任务状态
      • 删除升级任务
  • 【租户】分组管理
    • 设备分组管理
      • 创建设备分组
      • 设备分组详情查询
      • 设备分组分页查询
      • 更新设备分组
      • 删除设备分组
      • 设备分组树查询
      • 分组关联的用户列表查询
    • 设备关联分组
      • 添加设备到分组
      • 移除分组下设备
      • 获取分组下设备列表
      • 获取设备关联的分组列表
  • 【租户】设备模型(物模型)
    • 设备物模型
      • 自定义命令
        • 新建自定义命令
        • 删除自定义命令
        • 修改自定义命令
        • 分页查询自定义命令
        • 根据设备ID查自定义命令列表
      • 自定义控制
        • 创建-自定义控制
        • 删除-自定义控制
        • 更新-自定义控制
        • 分页查询自定义控制
      • 创建-物模型遥测
      • 创建-物模型属性
      • 创建-物模型事件
      • 创建-物模型命令
      • 删除-物模型遥测
      • 删除-物模型属性
      • 删除-物模型事件
      • 删除-物模型命令
      • 更新-物模型遥测(属性/命令/事件,参数一致,仅URI不一致)
      • 分页查询遥测数据(属性/命令/事件,参数一致,仅URI不一致)
      • 模板数据源指标查询(遥测、属性)
    • 设备模版管理
      • 获取设备模版选择器
      • 根据设备id获取设备模板详情
      • 获取设备模版(分页)
      • 更新设备模版
      • 创建设备模版
      • 获取设备模版详情
      • 删除设备模版
  • 【租户】设备模板
    • 设备/协议配置
      • 给设备批量添加配置
      • 设备模板凭证类型选择器
      • 协议凭证表单
      • 取设备模板协议配置表单
    • 数据处理脚本
      • 创建数据处理脚本
      • 数据处理脚本分页查询
      • 更新数据处理脚本
      • 删除数据处理脚本
      • 调试数据处理脚本
      • 启停数据脚本
    • 创建设备模板
    • 设备模板选择器
    • 设备模板详情查询
    • 设备模板分页查询
    • 更新设备模板
    • 删除设备模板
  • 【租户】服务接入
    • 创建服务接入点
    • 获取服务接入点列表
    • 删除服务接入点
    • 服务接入点配置表单查询
    • 修改服务接入点配置
    • 三方服务的设备列表查询
    • 批量添加设备到平台
  • 【租户】可视化
    • 看板
      • 创建看板
      • 看板分页查询
      • 更新看板
      • 首页看板查询
      • 看板详情查询
      • 删除看板
    • 可视化插件(即将废弃)
      • 可视化插件列表
      • 可视化批量上传
      • 新增Dashboard
      • 修改Dashboard
      • 删除Dashboard
      • 分页查询列表Dashboard
      • 本地可视化插件列表
      • 根据分享id获取可视化id
      • 生成分享id
  • 【租户】自动化
    • 通知历史
      • 获取通知历史列表
    • 告警
      • 新增告警配置
      • 删除告警配置
      • 编辑告警配置(包含启用停用)
      • 告警配置列表查询
      • 告警信息列表查询
      • 告警信息状态变更(已处理/忽略)
      • 告警信息状态批量变更(已处理/忽略)
      • 获取告警历史列表
      • 修改告警历史描述
      • 获取设备告警状态
      • 告警历史详情查询
    • 场景/场景联动
      • 场景
        • 创建场景
        • 删除场景
        • 分页查询场景
        • 获取场景详情
        • 修改场景
        • 激活场景
        • 场景日志查询
      • 场景联动
        • 创建场景联动
        • 删除场景联动
        • 修改场景联动
        • 开启/关闭场景联动
        • 分页查询场景联动
        • 获取场景联动详情
        • 获取场景联动日志
        • 根据设备ID查询 包含报警的场景联动(告警规则)
      • 一类设备动作选择下拉菜单
      • 单设备动作选择下拉菜单
      • 单设备条件选择下拉菜单
      • 一类设备条件选择下拉菜单
    • 通知组
      • 创建通知组
      • 获取通知组列表
      • 获取通知组详情
      • 更新通知组
      • 删除通知组
  • 【租户】系统管理
    • 权限
      • 给(多个)用户分配(多个)设备组权限
      • 查询用户拥有的设备组
      • 删除(多个)用户拥有的(多个)设备组
      • 给(多个)用户分配(多个)设备权限
      • 删除(多个)用户拥有的(多个)设备
      • 更新用户的设备组
      • 更新用户的设备
      • 查询用户的设备
      • 查询角色的权限
      • 修改角色的权限
      • 角色添加权限
      • 删除角色的权限
      • 查询用户的角色
      • 修改用户的角色
      • 用户添加多个角色
      • 删除用户的角色
    • 操作日志
      • 操作日志分页查询
    • 角色管理
      • 角色管理分页查询
      • 更新角色管理
      • 创建角色管理
      • 删除角色管理
  • 【租户】数据转发
    • 转发规则
      • 新增转发规则
      • 更新转发规则
      • 转发规则列表
      • 更新规则状态
      • 删除规则
      • 转发规则详情
    • 转发脚本
      • 转发脚本创建
      • 获取脚本详情
      • 转发脚本修改
      • 脚本测试
    • 转发数据源
      • 创建转发数据源
      • 更新转发数据源
      • 根据规则ID查询数据源
      • 删除转发数据源
      • 转发数据源详情
    • 转发目标配置
      • 创建转发目标配置
      • 转发目标配置详情
      • 更新转发目标配置
      • 转发目标配置列表
      • 删除转发目标配置
  • 【租户】设备
    • 网关设备
      • 网关下子设备列表分页查询
      • 移除子设备
      • 添加子设备
      • 未绑定网关的子设备选择器
    • 创建设备
    • 设备列表分页查询
    • 设备详情查询
    • 修改设备信息
    • 删除设备
    • 通过设备ID获取设备配置表单
    • 更新设备凭证信息
    • 激活设备
    • 设备编号校验
    • 设备选择器(配置ID和设备ID)
    • 凭证类型选择器
    • 更换设备模板
    • 设备在线离线状态查询
    • 根据设备查询已触发告警配置
    • 获取有设备权限的用户
    • 【企业】分页设备选择器
    • 获取带web图表信息的设备选择器
    • 设备连接信息查询
    • 设备选择器
  • 【租户】设备总合数据
    • 选择设备指标选择器
    • 设备单指标图表数据查询
  • 【租户】遥测数据
    • 设备遥测实时数据(ws)
    • 根据key获取设备遥测实时数据(ws)
    • 设备在线离线状态通知(ws)
    • 删除遥测数据
    • 根据设备ID获取最新的一条指标数据
    • 设备遥测当前值查询
    • 根据key查询指标当前值
    • 指标历史数值查询(带导出)
    • 指标历史数据查询(限一个月带分页)
    • 控制下发记录分页查询
    • 遥测聚合数据查询
    • 下发控制
    • 设备简单信息查询(带遥测数据)
    • 获取模拟设备发送遥测数据命令
    • 模拟设备发送遥测数据
    • 获取最新活跃的三个设备遥测数据
  • 【租户】属性数据
    • 下发属性
    • 向设备发送获取属性请求
    • 根据KEY查询属性信息
    • 设备属性列表查询
    • 删除属性数据
    • 属性下发记录分页查询
  • 【租户】事件数据
    • 事件数据分页查询
  • 【租户】命令数据
    • 期望消息
      • 期望消息列表查询
      • 新增期望消息
      • 删除期望消息
    • 下发命令
    • 命令标识符下拉选择器
    • 命令下发记录分页查询
  • 【租户】API密钥管理
    • 创建API密钥
    • 获取列表
    • 更新密钥
    • 删除密钥
    • 获取租户大屏APIkey
  • 文件相关
    • 上传文件
  • 【超管】应用管理
    • 插件管理
      • 注册服务插件
      • 更新服务插件
      • 删除服务插件
      • 协议/服务选择器
      • 获取单个服务的信息
      • 服务列表分页查询
      • 通过服务标识符查服务信息
  • 【超管】系统管理
    • 菜单管理
      • 获取租户菜单配置树
      • 菜单分页查询
      • 更新菜单
      • 创建菜单
      • 删除菜单
    • 字典管理
      • 创建字典列
      • 字典列表分页查询
      • 删除字典列(关联删除多语言)
      • 枚举查询接口
      • 创建字典多语言
      • 枚举多语言查询接口
      • 删除字典多语言
    • 系统功能设置
      • 查看系统功能
      • 修改系统功能开关
    • 通知服务配置
      • 发送短信测试
      • 通知服务配置
      • 发送测试邮件
      • 通知服务配置查询
    • 常规设置
      • 主题设置查询
      • 更新主题设置
    • 数据清理
      • 数据清理分页查询
      • 更新数据清理
  • ✨服务插件-平台提供
    • 获取设备配置(包含子设备配置)
    • 获取服务接入点列表
    • 获取服务接入点
    • 服务心跳上报
  • ✨服务插件-插件提供
    • 获取json表单-v1
    • 获取json表单-v2
    • 断开设备连接
    • 通知事件
    • 获取设备列表
  • 其他
    • 自动注册Modbus
      • 平台提供
        • 网关注册
      • 租户发送Modbus广播
  1. ✨设备调用

设备动态认证(一型一密)

测试中
本地
本地
POST
http://127.0.0.1:9999
/api/v1/device/auth
支持两种认证流程:
1.仅使用模板密钥的认证流程:设备仅关联到设备模板
2.使用模板密钥+ProductKey的认证流程:设备关联到特定产品

请求参数

Header 参数
x-token
string 
可选
默认值:
{{x-token}}
Body 参数application/json
template_secret
string 
模板密钥
必需
device_number
string 
设备唯一标识
必需
device_name
string 
设备名称
可选
可选
product_key
string 
产品密钥
可选
可选,用于产品关联
示例
{
  "template_secret": "string",
  "device_number": "string",
  "device_name": "string",
  "product_key": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1:9999/api/v1/device/auth' \
--header 'x-token: {{x-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "template_secret": "string",
    "device_number": "string",
    "device_name": "string",
    "product_key": "string"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
object 
必需
device_id
string 
必需
voucher
string 
必需
示例
{
  "code": 200,
  "message": "操作成功",
  "data": {
    "device_id": "4e7e16dc-b1e7-5eef-32a6-48a7d767c85f",
    "voucher": "{\"username\":\"6c2f1bdc-6fc2-b535-f0ba-f77fe9dc6db1\"}"
  }
}
修改于 2025-05-06 13:47:02
上一页
【租户】当前告警状态的设备数量
下一页
生成预注册设备
Built with