全新司空 2 OpenAPI V1.0
  1. 认证鉴权
全新司空 2 OpenAPI V1.0
  • 认证鉴权
    • 认证鉴权教程
  • 系统服务
    • 司空公有云接入点信息
    • 查询司空 2 系统状态
      GET
  • 组织项目
    • 组织项目教程
    • 获取组织下的项目列表
      GET
    • 获取组织下的设备列表
      GET
    • 获取项目下的设备列表
      GET
    • 获取项目的存储上传凭证
      GET
    • 添加人员到项目
      PUT
  • 设备管理
    • 设备管理教程
    • 物模型获取
      GET
    • HMS信息获取
      GET
    • 实时控制指令下发
      POST
    • 机场相机切换
      POST
    • 飞行器镜头切换
      POST
    • 控制权获取
      POST
    • 控制权释放
      DELETE
    • 图传清晰度设置
      PUT
    • 自定义网络RTK标定
      POST
    • 指定设备进入中继对频模式(仅支持私有云与中继设备)
      POST
    • 查询中继对频的结果(仅支持私有云与中继设备)
      GET
  • 直播管理
    • 直播管理教程
    • 直播推流
      • 开启直播
    • 旁路推流(仅支持私有云)
      • 码流转发错误码
      • 创建码流转发器
      • 开启/关闭码流转发器
      • 获取码流转码器列表
      • 删除码流转发器
  • 任务管理
    • 任务管理教程
    • 创建飞行任务
    • 更新飞行任务状态
    • 获取飞行任务信息
    • 获取飞行任务列表
    • 获取飞行任务产生的媒体资源
    • 获取飞行任务轨迹信息
  • 航线管理
    • 航线管理教程
    • 航线上传完成通知
    • 获取项目下的航线列表
    • 获取航线详情
  • 模型管理
    • 模型管理教程
    • 模型重建坐标系
    • 获取项目下的模型列表
    • 模型重建
    • 获取模型详情
  • 标注管理
    • 标注管理教程
    • 创建地图标注
  1. 认证鉴权

认证鉴权教程

功能介绍#

认证鉴权功能主要用于确保API的安全性和实现对司空 2 的访问控制。
认证是验证用户身份的过程, OpenAPI 通过在 Https 请求的Header参数中传入X-User-Token进行认证。
鉴权是指在认证通过后,确定用户是否有权限访问特定资源的过程, 司空 2 会针对传入的X-User-Token和X-Project-Uuid进行鉴权,请确保X-User-Token对应的用户具有该项目权限,才能正常访问该项目。
注意:X-User-Token是JWT票据,你可以通过 JWT Decoder( https://fusionauth.io/dev-tools/jwt-decoder ) 解析出该 Token 对应的用户信息,当鉴权失败的时候,请在司空 2 上查看该用户是否具有所访问项目的权限。
JWT票据示例:
image.png

接口使用流程#

请参考如下时序图离线获取用户 Token 和项目的 UUID,将X-User-Token和X-Project-Uuid传入到 OpenAPI 接口的Header参数中才能跟司空 2 进行通讯。
当前司空 2 的X-User-Token为云端互联的组织密钥。获取组织密钥的路径如下:司空 2 -> 我的组织 -> 组织设置 -> 云端互联 -> 组织密钥。
image.png
X-Project-Uuid可通过组织下的项目列表接口中的data.list.uuid获取。
以添加人员到项目为例:
下一页
司空公有云接入点信息
Built with