Parcourir la source

添加app升级接口文档

miricy il y a 1 an
Parent
commit
3a7bd7934a
1 fichiers modifiés avec 48 ajouts et 0 suppressions
  1. 48 0
      product/update.md

+ 48 - 0
product/update.md

@@ -0,0 +1,48 @@
+## apk升级接口
+
+GET 请求URL:
+[https://dev.izhiju.cn/api/v1/public/QJaWfWI9fyI/update](https://dev.izhiju.cn/api/v1/public/QJaWfWI9fyI/update)
+
+请求头参数:
+Content-Type: application/json
+
+查寻参数:
+
+
+| 参数名   | 参数类型 | 值                    | 说明                                                                                     |
+| -------- | -------- | --------------------- | ---------------------------------------------------------------------------------------- |
+| package  | string   | cn.izhiju.android.xxx | 升级apk包名,必须字段如:cn.izhiju.android.panela                                        |
+| key      | string   | 平台相关的密钥        | apk获取升级的密钥,必须字段                                                              |
+| version  | string   | 1.1.0.20240101        | 当前应用的版本号,必须字段                                                               |
+| deviceId | string   | ac:bc:cd:ee:11:22     | 设备ID或MAC地址,必须字段,后台添加限制时保持一致即可,智能家居应用目前定为大写MAC去冒号 |
+
+组合出的请求URL样例:
+https://dev.izhiju.cn/api/v1/public/QJaWfWI9fyI/update?package=cn.izhiju&version=2&deviceId=3&key=4
+
+返回结果:
+
+1. 成功,状态码200,返回如下内容:
+
+```json
+{
+  "type": "appVersion",
+  "id": "BQFICmih0e4",
+  "scopeId": "QJaWfWI9fyI",
+  "createdOn": "2024-07-22T08:13:07.952Z",
+  "createdBy": "KeiN_96ZIUE",
+  "modifiedOn": "2024-07-22T08:13:07.952Z",
+  "modifiedBy": "KeiN_96ZIUE",
+  "optlock": 1,
+  "packagename": "cn.izhiju.android.panele",
+  "version": "V1.2.0.20240722160038", //最新升级包版本号
+  "url": "https://izhiju.oss-cn-beijing.aliyuncs.com/apk/panele_android_v1.2.0.20240722160038_release.apk",
+  "types": "all", //升级类型,all全量包,patch增量包
+  "comment": "1.窗帘无状态,5秒延时回弹\n2.优化UI和功能"  //升级内容描述
+}
+```
+
+如果状态码为200,内容为空,也表示没有查寻到升级信息
+
+2. 失败,状态码401,授权失败或密钥错误,无需额外处理返回内容
+3. 失败,状态码204,没有查寻到升级信息,或当前已经是最新版本,无需处理返回内容
+4. 失败,状态码400,500,没有查寻到升级信息,或当前已经是最新版本,无需处理返回内容