快速开始 | 小鹰云空间感知能力开放平台接入指南

Quick Start

平台对接快速入门指南

从账号、密钥、摄像机 license 到 WebRTC 预览,把基础操作步骤和接入代码打包成可复制模板,方便直接放进自己的平台联调。

env

环境配置模板

XY_OPEN_ID=your_open_id
XY_SECRET=your_server_secret
XY_DEVICE_ID=your_camera_device_id
XY_LICENSE_ID=your_camera_license_id
需要完整字段说明、接口列表和 SDK Demo,可继续查看文档中心。查看完整指南

建立可验证的开放平台接入路径

稳定的项目接入需要把账号密钥、设备接入、视频播放、AI 识别和业务回调分层处理。这样既能减少前端暴露敏感信息,也便于对每一次识别结果进行复核和追溯。

密钥只放在服务端

secret、签名密钥和设备凭证应保存在自己的业务服务中,浏览器只接收当前会话所需的最小数据。

先验证设备状态

在测试视频或 AI 结果前,先确认设备身份、型号支持、在线状态、网络质量和摄像机角度。

形成事件闭环

通过 HTTPS 回调、重试、幂等和复核记录,让 AI 事件进入通知、处置和运营报表流程。

接入验收清单

  1. 1应用可以在不暴露 secret 的前提下完成服务端签名。
  2. 2目标摄像机在线,且设备型号支持项目需要的能力。
  3. 3播放地址、截图或 AI 事件可以在测试环境完成验证。
  4. 4回调失败可以安全重试,重复事件可以被识别和去重。

从账号准备到正式上线

把接入过程拆成可以逐项验证的交付路径。每个阶段都留下清晰结果,便于开发、运维和业务负责人共同确认。

1

准备账号与环境

创建应用并申请 open_id、secret,确认本次接入使用的组织、测试环境和生产环境。

2

完成设备接入

通过设备接口完成添加、绑定和查询,确认设备型号、在线状态、网络质量和所需权限。

3

验证视频与 AI 能力

先在测试环境验证实时预览、截图、回放、AI 识别和事件报文,再开启生产业务流程。

4

上线事件回调闭环

配置 HTTPS 回调,做好失败重试和重复事件去重,并把告警接入通知、工单、复核和报表。

常见接入问题

secret 可以放在浏览器端吗?

不可以。secret 和签名逻辑应放在服务端,浏览器只接收短时有效且满足当前页面所需的最小数据。

测试 AI 能力前要检查什么?

需要检查设备身份、型号能力、摄像机角度、光照、网络稳定性,以及业务需要的事件规则。

如何让事件回调更可靠?

建议使用 HTTPS、请求签名、超时策略、退避重试、幂等键和事件记录,便于失败恢复与后续复核。