此页面由 AI 自动翻译。查看英文原版

本页目录

  • 标准架构
  • 典型集成流程
  • 公共 API 分割
  • 浏览器会话引导
  • 前端渲染指南
  • 当前产品边界
  • 后续步骤

集成架构

在设计客户门户、运营仪表板或依赖 Luxonis Hub 的后端集成时,请使用此页面。它解释了生产集成的默认架构,以及身份验证、控制平面 API 调用和浏览器会话引导应位于何处。

标准架构

对于大多数生产部署,Luxonis Hub 应位于您自己的产品后端之后,而不是作为主要的前端身份验证边界。默认集成模型是:
  1. 客户用户向您的产品进行身份验证。
  2. 您的前端调用您的后端。
  3. 您的后端调用 Luxonis Hub API 和浏览器会话引导操作。
  4. 您的前端仅接收渲染、控制或设备会话所需的派生负载。
请明确遵守这些规则:
  • 客户身份验证保留在您的用户、您的前端和您的后端之间。
  • Hub API 密钥仅保留在您的后端或服务器端工具中。
  • 浏览器永远不应接收 Hub API 密钥。

典型集成流程

这是面向客户的 Hub 集成的最常见实际模式:
  1. 用户打开您的客户门户或内部运营 UI。
  2. 您的前端从您的后端请求设备状态、应用程序状态或会话访问。
  3. 您的后端调用 Luxonis Hub GraphQL,并在需要时调用会话引导操作。
  4. 您的后端仅返回您的前端所需的应用程序数据或连接负载。
  5. 您的前端渲染结果或打开远程会话。
这会将身份验证和 Hub 凭据保留在服务器端,同时仍允许在需要时进行直接的浏览器端会话传输。

公共 API 分割

Luxonis Hub 目前公开两种面向客户的 API 样式:
  • GraphQL 控制 API,用于设备、应用程序、快照、控制平面读取、突变和浏览器会话引导。
  • REST 模型 API,用于高级模型注册表和转换自动化。
这种分割是正常的。如果您的产品同时使用舰队控制和模型管理工作流,您将需要集成两者。对于外部 GraphQL 集成,请使用公共 team { ... } 接口。

浏览器会话引导

对于浏览器端设备和应用程序会话,您的后端应调用 GraphQL 控制 API,并将引导负载返回给前端。相关的 GraphQL 操作包括:
  • requestDeviceWebrtcConfig 用于设备会话,例如 Web 终端和实时日志。
  • requestDeviceAppConnection 用于通过 oak-webrtc 进行应用程序和可视化工具会话。
这会将 Hub 凭据保留在您的后端,同时仍允许浏览器直接连接到远程会话传输。

前端渲染指南

对于客户门户,推荐的渲染原语是可视化工具。当您需要以下内容时,请使用可视化工具:
  • 实时视频
  • 检测和叠加
  • 更丰富的输出,例如点云
将完全自定义渲染视为高级/自定义路径,适用于可视化工具不适用的情况。直接同局域网 WebSocket 或设备本地访问仍然可以作为备用路径,但它不是客户门户的标准远程集成模型。

当前产品边界

在您的集成设计中明确这些边界:
  • Hub API 密钥目前是完全访问的团队机密。
  • 请结合使用官方 GraphQL 指南和参考页面以及模式检查。
  • Webhook 尚未成为广泛稳定的公共集成接口。
  • 基于清单的推出和大规模部署编排目前不可用。
  • 自托管主机操作系统仍由客户管理。

后续步骤