技术支持与 API 文档（仅做参考）

提供灵活的 API 接口，助力开发者和企业客户深度集成我们的云盒服务和设备管理功能。

云端控制 API

本地盒子 API

SDK 信息

云端 API 用于用户身份验证、设备列表查询、云存储时间线获取以及云端服务启停等操作。

接口概览

方法	路径	描述	需要授权
GET	`/api/v1/devices`	获取当前用户绑定的所有设备列表	是
POST	`/api/v1/cloud/stream/start`	远程通知盒子开始向云端推流	是
GET	`/api/v1/storage/timeline/{deviceId}`	查询指定设备在某时间段的云存储时间线	是
POST	`/api/v1/auth/token`	用户登录，获取访问 Token	否

示例：获取设备列表

请求：使用您在登录接口获得的 Bearer Token 进行认证。

curl -X GET 'https://api.yunhe.com/api/v1/devices' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

响应：

{
  "code": 200,
  "data": [
    {
      "deviceId": "GW-C200-001",
      "name": "前门摄像头",
      "status": "online",
      "ip": "192.168.1.100"
    },
    {
      "deviceId": "DIY-RPi-002",
      "name": "仓库监控",
      "status": "offline",
      "ip": "N/A"
    }
  ]
}

本地 API 用于直接控制局域网内的云盒硬件，例如配置RTSP源、系统重启和固件升级等。请确保请求来自盒子所在的局域网。

接口概览

方法	路径	描述	认证方式
POST	`/box/v1/config/rtsp`	配置/更新本地摄像头的 RTSP 源地址	本地密钥
POST	`/box/v1/system/reboot`	安全重启云盒设备	本地密钥
GET	`/box/v1/status`	获取盒子运行状态和固件信息	否

示例：配置 RTSP 源

请求：使用盒子内部生成的本地访问密钥进行授权。

curl -X POST 'http://192.168.1.50:8080/box/v1/config/rtsp' \
-H 'X-Local-Key: BOX_SECRET_KEY_123' \
-H 'Content-Type: application/json' \
-d '{
    "camera_id": "cam_01",
    "rtsp_url": "rtsp://admin:password@192.168.1.200/h264/ch1/main/av_stream"
}'

移动端 SDK (iOS & Android)

我们为移动端应用提供原生 SDK，方便您快速集成视频播放、实时通知和远程控制功能。

iOS SDK: 提供 Swift 和 Objective-C 接口，通过 CocoaPods 管理。支持硬件解码和低延迟播放。
Android SDK: 提供 Java 接口，通过 Gradle 集成。支持多路并行播放和自定义渲染。
集成文档: [点击此处下载完整集成手册 (PDF)]

Web 集成

对于 Web 应用，我们推荐使用我们提供的 WebRTC/WebSocket 接口进行视频流传输，并使用上述云端 API 进行业务逻辑控制。