Skip to the content.

工业边缘网关 API 文档

欢迎使用工业边缘网关 API 文档。本 API 符合 RESTful 规范,使用 JSON 作为请求和响应体。

基础 URL (Base URL)

http://<gateway-ip>:<port>/api

默认端口通常为 8080 或 9090,具体取决于配置。

认证鉴权 (Authentication)

大多数端点需要 JWT 认证。

  1. 调用 GET /auth/nonce 获取一次性随机数 (nonce)。
  2. 调用 POST /auth/login 使用用户名和加密密码登录 (加密方式:SHA256(密码原文 + nonce))。
  3. Authorization 请求头中使用返回的 token: Bearer <token>

文档模块

通用响应格式

成功:

{
  "code": "0", //  HTTP 200 直接返回数据
  "msg": "Success",
  "data": { ... }
}

错误:

{
  "code": "1", //  HTTP 4xx/5xx
  "error": "错误信息描述"
}