UpgradeLink

主题

Electron应用获取升级策略 ​

接口描述：基于客户端的版本号，获取对应的升级策略,兼容electron官方提供的升级接口。

📮请求信息 ​

请求地址 ​

GET http://0.0.0.0:8888/v1/electron/upgrade?electronKey=kPUtUMDIjBhS48q5771pow&versionName=1.1.1&appointVersionName=&devModelKey=&devKey=&platform=darwin&arch=arm64

请求头 (Headers) ​

参数名必选类型示例值说明
X-AccessKey是stringmui2W50H1j-OC4xD6PgQag密钥 AccessKey

请求参数说明 ​

参数名必选类型示例值说明
electronKey是stringkPUtUMDIjBhS48q5771powElectron应用唯一标识
versionName是string1.0.0系统中录入的版本号
appointVersionName否string1.0.1期望升级版本号，不传或传空为请求最新版本
devModelKey否stringstv1设备机型唯一标识
devKey否stringLOYlLXNy7w设备唯一标识(可以使用 mac 作为唯一标识)
platform是stringlinux操作系统:linux、darwin、windows
arch是stringx86_64机器架构:x86、arm64

📮响应信息 ​

成功响应体 ​

json
{
  "upgradeType": 1,
  "promptUpgradeContent": "提示升级内容",
  "version": "1.2.0",
  "files": [
    {
      "url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
      "sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
      "size": 153453614
    },
    {
      "url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
      "sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
      "size": 153453614
    }
  ],
  "path": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
  "sha512": "sSrgmnph5Cr2AuZwCEWXD90JiJ2JW0RnqLf8cXSxusHLssCPRlAFtpER74Rlw/LglbOlcYvh+IO3jsAxAdLQmw==",
  "releaseDate": ""
}

响应体参数说明 ​

返回内容与官方打包的 yml 文件内容 返回内容一致。

参数名类型示例值说明
upgradeTypeint提示升级类型 1：提示升级；2：静默升级；3: 强制升级
prompt_upgrade_contentstring提示升级内容
versionstring版本号
pathstring更新文件下载路径
sha512string更新文件 sha512 校验值

典型错误响应体 ​

json
{
  "code": 404001,
  "msg": "未获取到可使用版本",
  "docs": "未查询到对应的应用版本，请确认在系统中是否已经正确创建。 请参考文档: http://upgrade.toolsetlink.com/upgrade/recommend/tauri/app-version.html",
  "data": null
}

📊状态码 ​

http 状态码code场景描述解决方案
200请求成功，获取到版本升级策略
400400001非法请求
400400002参数缺失
400400003参数非法
400400004报头非法
400400005报体非法
401401001鉴权失败
401401002签名验证失败
404404001资源不存在
404404002查询记录不存在
404404003处理方式不存在
404404004请求不存在
429429001应用任务策略请求流控限制当前升级任务配置的请求流控策略，已经达到限制，请稍后再试。
500500001服务器内部错误请联系我们 联系我们
500500002服务器内部校验数据失败请联系我们 联系我们