1. 功能说明

用于产品升级,包括设备、移动端程序等

2. 协议设计原则

  • 简化原则,目前统一使用POST方法
  • 采用json文本协议,保证协议可读性高和扩展性
  • 不添加额外的HTTP头部信息,只使用标准HTTP头部信息
  • 所有的参数都在http的body部分
  • json内容主要分header和body两部分,最上层为具体服务的缩写,本服务为PUS
  • 所有的字段类型为string

3. 调用地址

POST https://pus.wonlycloud.com:10400

4. 消息类型定义

定义 描述
MSG_PRODUCT_UPGRADE_UP_REQ 请求产品更新上传
MSG_PRODUCT_UPGRADE_UP_RSP 应答产品更新上传
MSG_PRODUCT_UPGRADE_DOWN_REQ 请求产品更新下载
MSG_PRODUCT_UPGRADE_DOWN_RSP 应答产品更新下载

5. 协议详解

每条协议都包含请求应答示例、请求参数说明、应答参数说明三个部分

5.1 产品更新上传

  • 请求应答示例

MSG_PRODUCT_UPGRADE_UP_REQ

{
    "PUS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PRODUCT_UPGRADE_UP_REQ",
            "seq_id": "1"
        },
        "body": {
            "token": "xxxxxxxxxxxxxxx",
            "vendor_name": "general",
            "platform": "device",
            "endpoint_type": "z501",
            "part": "mcu,wifi,video",
            "new_version": "1.0.1",
            "force_upgrade": "true,false,false",
            "readme": "example: Repair major bug",
            "url": "http://download.wonlycloud.com/general/device/z501_mcu_1.0.0.bin,http://download.wonlycloud.com/general/device/z501_wifi_1.0.0.bin,http://download.wonlycloud.com/general/device/z501_video_2.1.173.bin",
            "md5": "24eabe548bcaaa5e8bd779288dd75a00,04bd19cb62a007f046b538d479a4e4c5,eddc28892e3dca216a4f885a7f8252a1"
        }
    }
}

MSG_PRODUCT_UPGRADE_UP_RSP

{
    "PUS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PRODUCT_UPGRADE_UP_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
token 必填 授权令牌 通过AMS申请获得
vendor_name 必填 产品名称 vendor_name公共参数
platform 必填 平台类型 公共参数
endpoint_type 必填 终端设备类型 终端设备的类型,general virtual feibee eques wulian z501WonlyBtLock(爱感蓝牙锁)WonlyNBLock (王力NB锁)WonlyNBVideoLock (王力NB视频锁)robot (王力机器人)WL025S1 (平板镶嵌)
part 可选 产品的模块 设备会有多个程序需要分开升级,由三部分版本组成,用,分割
new_version 必填 需更新的版本 返回对应的最新版本号,设备的版本,由三部分版本组成,用,分割,顺序根据part字段来区分
force_upgrade 必填 是否强制更新 是否强制更新,只有true false,设备的版本,由三部分版本组成,用,分割,顺序根据part字段来区分
readme 可选 更新说明 下载新版本的地址
url 必填 下载地址 下载新版本的地址,设备的下载,由三部分版本组成,用,分割,顺序根据part字段来区分
md5 可选 文件的md5值 设备文件的md5值,由三部分版本组成,用,分割,顺序根据part字段来区分`

5.2 产品更新下载

  • 请求应答示例

MSG_PRODUCT_UPGRADE_DOWN_REQ

{
    "PUS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PRODUCT_UPGRADE_DOWN_REQ",
            "seq_id": "1"
        },
        "body": {
            "token": "xxxxxxxxxxxxxxx",
            "vendor_name": "general",
            "platform": "android",
            "endpoint_type": "z501",
            "current_version": "1.0.0"
        }
    }
}

MSG_PRODUCT_UPGRADE_DOWN_RSP

{
    "PUS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PRODUCT_UPGRADE_DOWN_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "part": "mcu,wifi,video",
            "new_version": "1.0.1",
            "force_upgrade": "true,false,false",
            "readme": "example: Repair major bug",
            "url": "http://download.wonlycloud.com/general/device/z501_mcu_1.0.0.bin,http://download.wonlycloud.com/general/device/z501_wifi_1.0.0.bin,http://download.wonlycloud.com/general/device/z501_video_2.1.173.bin",
            "md5": "24eabe548bcaaa5e8bd779288dd75a00,04bd19cb62a007f046b538d479a4e4c5,eddc28892e3dca216a4f885a7f8252a1",
            "size": "10MB"
        }
    }
}
参数 选项 说明 备注
token 必填 授权令牌 通过AMS申请获得
vendor_name 必填 产品名称 vendor_name公共参数
platform 必填 平台类型 公共参数
endpoint_type 必填 终端设备类型 终端设备的类型,general virtual feibee eques wulian z501 WonlyBtLock(爱感蓝牙锁)WonlyNBLock (王力NB锁)WonlyNBVideoLock (王力NB视频锁) robot (王力机器人)WL025S1 (平板镶嵌)robot_amy(艾米机器人程序)robot_pad_sys (平板小管家安卓系统)
current_version 可选 当前端的版本号 当前端的版本号
参数 说明 备注
part 产品的模块 设备会有多个程序需要分开升级,由三部分版本组成,用,分割
new_version 需更新的版本 返回对应的最新版本号,设备的版本,由三部分版本组成,用,分割,顺序根据part字段来区分
force_upgrade 是否强制更新 是否强制更新,只有true false,设备的版本,由三部分版本组成,用,分割,顺序根据part字段来区分
readme 更新说明 更新说明,有换行的文字,用,分割
url 下载地址 下载新版本的地址,设备的下载,由三部分版本组成,用,分割,顺序根据part字段来区分
md5 文件的md5值 设备文件的md5值,由三部分版本组成,用,分割,顺序根据part字段来区分
size 文件的大小 文件的大小