版本管理

获取 App 所有版本、设置与取消最新版本、检测 App 更新，以及删除版本的接口说明。

本页介绍与 App 版本管理相关的接口。

获取 App 所有版本

分页获取某个 App 的全部历史版本信息。

POSThttps://www.pgyer.com/apiv2/app/builds

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
appKey	String	是	见 appKey
buildKey	String	否	见 buildKey
page	Integer	否	历史版本分页页数

返回数据

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildType	Integer	应用类型（1:iOS; 2:Android）
buildFileSize	Integer	App 文件大小
buildName	String	应用名称
buildVersion	String	版本号，默认为 1.0
buildVersionNo	String	上传包的版本编号，默认为 1
buildBuildVersion	Integer	蒲公英生成的用于区分历史版本的 build 号
buildIdentifier	String	应用程序包名，iOS 为 BundleId，Android 为包名
buildIcon	String	应用 Icon 图标 key，访问地址为 `https://cdn-app-icon2.pgyer.com/<buildIconPath>/<buildIcon>?x-oss-process=image/resize,m_lfit,h_120,w_120/format,jpg`，buildIconPath 为 buildIcon 前 5 个字符用 `/` 连接
buildCreated	String	应用上传时间
pageCount	Integer	版本总页数
currentPage	Integer	当前页

{
  "code": 0,
  "message": "",
  "data": {
    "pageCount": 3,
    "currentPage": 1,
    "list": [
      {
        "buildKey": "a1b2c3d4e5f6",
        "buildType": 2,
        "buildFileSize": 12345678,
        "buildName": "示例应用",
        "buildVersion": "1.1",
        "buildVersionNo": "28",
        "buildBuildVersion": 5,
        "buildIdentifier": "com.example.app",
        "buildIcon": "123abcdefaaa",
        "buildCreated": "2025-01-01 10:00:00"
      }
    ]
  }
}

设置最新版本

将某个 buildKey 对应的版本标记为最新版本。

POSThttps://www.pgyer.com/apiv2/app/setNewestVersion

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
buildKey	String	否	见 buildKey

返回数据

参数	类型	说明
code	Integer	`0` 表示设置成功，大于 0 见错误码含义
message	String	处理结果信息

{
  "code": 0,
  "message": "设置成功"
}

取消最新版本

取消某个 buildKey 对应版本的「最新版本」标记。

POSThttps://www.pgyer.com/apiv2/app/cancelNewestVersion

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
buildKey	String	否	见 buildKey

返回数据

参数	类型	说明
code	Integer	`0` 表示取消成功，大于 0 见错误码含义
message	String	处理结果信息

{
  "code": 0,
  "message": "取消成功"
}

检测 App 是否有更新

用于在客户端检查 App 是否存在新版本，并返回更新信息。

POSThttps://www.pgyer.com/apiv2/app/check

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
appKey	String	是	见 appKey
buildVersion	String	否	使用 App 本身的 Build 版本号。Android 对应字段为 `versionname`，iOS 对应字段为 `version`
buildBuildVersion	Integer	否	使用蒲公英生成的自增 Build 版本号
channelKey	String	否	渠道 Key

返回数据

参数	类型	说明
buildBuildVersion	Integer	蒲公英生成的用于区分历史版本的 build 号
forceUpdateVersion	String	强制更新版本号（未设置强制更新时为空）
forceUpdateVersionNo	String	强制更新的版本编号
needForceUpdate	Boolean	是否强制更新
downloadURL	String	应用安装地址
appURl	String	应用安装单页地址
buildHaveNewVersion	Boolean	是否有新版本
buildVersionNo	String	上传包的版本编号，默认为 1
buildVersion	String	版本号，默认为 1.0
buildDescription	String	应用介绍
buildUpdateDescription	String	应用更新说明
appKey	String	独立 App 的唯一标识符
buildKey	String	独立 App 版本的唯一标识符
buildName	String	应用名称
buildIcon	String	应用图标
buildFileKey	String	文件存储 Key
buildFileSize	String	文件大小

{
  "code": 0,
  "message": "",
  "data": {
    "buildBuildVersion": 5,
    "forceUpdateVersion": "",
    "forceUpdateVersionNo": "",
    "needForceUpdate": false,
    "downloadURL": "https://www.pgyer.com/apiv2/app/install?_api_key=xxx&buildKey=a1b2c3d4e5f6",
    "appURl": "https://www.pgyer.com/abcd",
    "buildHaveNewVersion": true,
    "buildVersionNo": "28",
    "buildVersion": "1.1",
    "buildDescription": "示例介绍",
    "buildUpdateDescription": "修复若干问题",
    "appKey": "x1y2z3",
    "buildKey": "a1b2c3d4e5f6",
    "buildName": "示例应用",
    "buildIcon": "123abcdefaaa",
    "buildFileKey": "apps/xxx/yyyy/zzzz.apk",
    "buildFileSize": "12345678"
  }
}

删除版本

删除某个 App 的指定版本。如需整体删除应用，请使用删除应用接口。

删除操作不可恢复，调用前请确认 buildKey 无误。

POSThttps://www.pgyer.com/apiv2/app/buildDelete

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
buildKey	String	是	见 buildKey

返回数据

参数	类型	说明
code	Integer	`0` 表示删除成功，大于 0 见错误码含义

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

本页目录