OpenAPI V1.0

2026-10-16

API 简介

大疆司空 2 OpenAPI 是一个基于 RESTful 规范的开放平台，旨在为开发者提供三方云平台与大疆司空 2 进行交互的能力。

以下是 OpenAPI 的一些关键特性和功能：

  • RESTful 设计：采用 RESTful 规范，使得 API 的使用更加直观和符合 Web 标准。开发者可以通过标准的 HTTP 方法（如 GET、POST、PUT、DELETE）与司空 2 进行交互。
  • 认证与鉴权：平台提供了认证鉴权安全机制，确保 API 的安全性和访问控制。
  • 司空 2 功能交互：提供了大疆司空 2 组织项目，设备管理，直播管理，航线管理，任务管理，模型管理，标注管理等功能。
  • 开发者支持与文档：提供了详尽的 API 文档、示例代码和开发者支持，帮助开发者快速理解和使用平台功能。

开发者可通过调用 OpenAPI 快速集成司空 2 的核心功能，显著降低开发成本，满足不同的业务需求和创新应用场景。

产品架构

快速入门

环境搭建（司空 2 私有版特有）

请参考《大疆司空 2 私有版部署手册》部署司空 2 私有版。

认证鉴权

请参考认证鉴权教程open in new window 了解 OpenAPI 认证鉴权原理，获取X-User-Token和X-Project-Uuid，这两个参数将在大部分接口的header字段中传入，用于确保 OpenAPI 的安全性和实现对司空 2 的访问控制。

示例代码

1. 查询司空 2 系统状态

司空 2 公有云调用接口查询系统状态： 查询司空 2 系统状态open in new window

当司空 2 私有版正常部署后，调用接口查询系统状态： 查询司空 2 系统状态open in new window

```http
GET /openapi/v0.1/system_status HTTP/1.1
Host: 127.0.0.1:30812
X-Language: zh
X-User-Token: xxxxxxxx

接口返回0，则表示司空 2 系统正常运行：

```http 
{
  "code": 0,
  "message": ""
}

2. 获取组织下的项目列表

在司空 2上创建组织，创建项目和绑定设备。请参考司空 2 使用说明> 组织管理章节在司空 2 中进行相关组织和项目创建操作, 然后调用 获取组织下的项目列表open in new window 接口获取已创建的项目列表。

GET /openapi/v0.1/project HTTP/1.1
Host: 127.0.0.1:30812
X-Language: zh
X-User-Token: xxxxxxxx

返回已创建的项目列表：

```http 
{
  "code": 0,
  "message": "OK",
  "data": {
    "list": [
      {
        "name": "c2c_test",
        "introduction": "a",
        "uuid": "93df839d-ae74-4f04-842e-2f1f81c89a66",
        "org_uuid": "105ddd05-34ce-46b6-a872-cb32b8c98f64",
        "created_at": 1702498686,
        "updated_at": 1702498686,
        "project_work_center_point": {
          "latitude": 22.906899500237845,
          "longitude": 113.69995967214662
        }
      }
    ]
  }
}

3. 开启直播功能

请参考司空 2 使用说明:设备管理章节在司空 2 中进行相设备绑定操作， 然后参考直播管理教程open in new window, 调用 开启直播open in new window 接口开启直播推流。

```http 
POST /openapi/v0.1/live-stream/start HTTP/1.1
Host: 127.0.0.1:30812
X-Project-Uuid: xxxxxxxxxx
X-Language: zh
Content-Type: application/json
X-User-Token:  xxxxxxxx 
Content-Length: 120

{
    "sn": "7CTDM3Dxxxxxx",
    "camera_index": "165-0-7",
    "video_expire": 7200,
    "video_quality": "adaptive"
}

返回直播链接: data.url，访问该地址可以正常查看直播：

```c
{
  "code": 0,
  "message": "",
  "data": {
    "expire_ts": 1764751629,
    "url": "http://127.0.0.1:30806/rtc/v1/whep/?app=live&stream=7CTDM3Dxxxxxx_165-0-7&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9kdWN0X2lkIjoiNzEzNTE5ZmIxYjRlNDRiYTlkMjdkMDJhOGRlZDk5NGQiLCJjaGFubmVsX25hbWUiOiI3Q1RETTNEMDBCWk5WWl8xNjUtMC03IiwidWlkIjoxDAxMTQsImFjdGlvbiI6InBsYiLCJleHAiOjE3NjQ3NTE2MzAsIm5iZiI6MTczMzIxNTYzMCwiaWF0IjoxNzMzMjE1NjMwfQ._AysitutpprlgYGFy4lDL_gSv4Y3hl_te-yxoFVHZb4",
    "url_type": "srs"
  }
}

接口文档

Last Updated: