云端互联 API 是司空与三方云平台的交互 API 管理。

注：云端互联 API 将逐步迁移至司空 Sync OpenAPI。新接入用户请直接使用 司空 Sync 及 EventAPI。

使用云端互联 API 时，需注意：

• 用户需在请求的 Header 中增加字段 X-Organization-Key，配置组织密钥，作为组织的身份认证凭证。
• 用户可调用 获取组织下的项目列表、获取指定项目的设备列表 和 获取任务详情 接口来获取任务与设备的相关信息。
• 进入司空 2 项目列表页后，用户可在当前网页链接中获取组织 ID。

公有云

私有版

云端互联 Webhook

当生成文件时，司空 2 会通过 Webhook URL 向第三方云平台推送通知。

注：司空 Sync 已提供全新的 EventAPI 服务，支持更丰富的事件类型和灵活的规则配置，详见 EventAPI。

司空平台新文件生成通知 接口：

{
    "notify_type": "file_uploaded",
    "notify_time": "2023-11-07T12:00:00.582627+00:00",
    "data": {
        "organization_id": "Organization ID",
        "workspace_id": "Project ID",
        "file": {
            "id": "File ID",
            "name": "File Name",
            "object_key": "Object Storage Key",
            "type": 5 // 5-Flight route files，7-3D mapping files
        }
    }
}

云端互联 API

以下接口将逐步迁移至司空 Sync OpenAPI：

接口名称	迁移状态
获取 AI 告警列表及快照内容	已迁移至 EventAPI
获取组织下的项目列表	迁移中
获取指定项目的设备列表	迁移中
发布通知及创建地图元素	迁移中
获取项目临时上传凭证	迁移中
航线上传通知	迁移中
获取生成文件信息及下载地址	迁移中
旁路推流接口	迁移中
任务下发接口	迁移中

其他请求说明，详见 云端互联 API 总览。

注：云端互联功能已完成公测并升级为司空 Sync。码流转发功能会扣除当前组织的直播分钟数，扣除时间从创建转码器（发起码流转发）开始计算，每个转码器会单独计算，删除转码器（关闭码流转发）后结束扣除。