概述

上云API中除了使用MQTT协议外，有部分功能还需要通过http/https短连接方式和服务器进行通信。由于三方业务应用多种场景，需要基于DJI Pilot 2开放一定的结合业务的自由度，因此DJI Pilot 2内嵌一个Webview组件，该组件可以通过配置https请求URL链接，直接访问第三方云平台的H5网页，在该网页中注册登录开发者自定义的账号密码之后，可以换取Token、MQTT网关地址等信息，Webview组件拿到这些信息之后，通过JSBridge接口传给DJI Pilot 2 应用层和DJI Pilot 2设备层，应用层加上Token进行应用业务通信，设备层则进行MQTT认证连接。

接口格式

{URI-scheme}://{Endpoint}/{{module}}/api/{api_version}/{resouce_path}?{query_string}

其中：

• URI-scheme: 强制使用安全性高的https
• Endpoint: 服务域名或ip
• module: 功能模块
• api_version: api版本号，用于管理api版本
• resource_path: 资源路径
• query_string: 查询参数，非必须

请求方式

支持的请求方式如下：

• GET
• PUT
• POST
• DELETE

请求中 Content-Type 需使用 application/json

任意接口都可以在 header 中加入如下参数：

参数名	类型	参数位置	必填	说明
X-Auth-Token	String	header	是	令牌, access_token
X-Device-ID	String	header	否	设备ID号，用于有时服务端需要判断机型来做相应处理动作，暂时不用
X-Firmware-Version	String	Header	否	飞机的固件版本号
X-Request-ID	String	Header	否	Uuid, 标识http请求

参数规范：

• GET DELETE请求： 参数位置在query中
• POST PUT请求：参数位置为请求header中，为json格式。

Response规范

{
   "code":0,
   "message":"string",
   "data": {},
}

错误码

• 2xx：成功，操作被成功接收并处理
  • 200：请求成功。一般用于GET与POST请求
  • 201：已创建。成功请求并创建了新的资源
• 3xx：重定向，需要进一步的操作以完成请求
  • 301：永久移动。请求的资源已被永久的移动到新URI，返回信息会包括新的URI，浏览器会自动定向到新URI。今后任何新的请求都应使用新的URI代替
  • 304：未修改。所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。客户端通常会缓存访问过的资源，通过提供一个头信息指出客户端希望只返回在指定日期之后修改的资源
• 4xx：客户端错误，请求包含语法错误或无法完成请求
  • 400：客户端请求的语法错误，服务器无法理解
  • 401：请求要求用户的身份认证
  • 403：服务器理解请求客户端的请求，但是拒绝执行此请求
  • 404：服务器无法根据客户端的请求找到资源（网页）。通过此代码，网站设计人员可设置”您所请求的资源无法找到”的个性页面
  • 410：客户端请求的资源已经不存在。410不同于404，如果资源以前有现在被永久删除了可使用410代码，网站设计人员可通过301代码指定资源的新位置
• 5xx：服务器错误，服务器在处理请求的过程中发生了错误
  • 500：服务器内部错误，无法完成请求

DJI Pilot对应的错误码行为：

状态码	App行为 （在图传页面）	App行为（不在图传页面）
2xx	正常流程	正常流程
3xx	正常流程	正常流程
400	toast 提示“参数错误，请重试，或联系管理员”	toast 提示“参数错误，请重试，或联系管理员”
401	1. toast提示“云平台登录失效，请重新登录” 2. 云平台做退云处理	1. 云平台做退云处理 2. 弹框提示，去登录
403	toast提示“您无操作权限，请重试，或联系管理员”	toast提示“您无操作权限，请重试，或联系管理员”
404	toast提示“资源不存在，请重试，或联系管理员”	toast提示“资源不存在，请重试，或联系管理员”
5xx	toast提示"服务器异常，请稍等重试（resp.code）”	toast提示"服务器异常，请稍等重试（resp.code）“
未知	toast提示“网络请求异常，请稍后重试（resp.code）”	toast提示“网络请求异常，请稍后重试（resp.code）”