应用信息

获取与修改蒲公英 App 详细信息的接口，包含查看自己上传的应用、通过短链接获取 App 信息等。

本页介绍与 App 详细信息相关的接口，包括获取详情、修改详情、查看自己上传的应用，以及通过短链接获取 App 信息。

获取 App 详细信息

获取某个 App 某个具体版本的详细信息，返回值中同时包含该 App 的历史版本摘要。

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

请求参数

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

返回数据

应用详情字段：

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildType	Integer	应用类型（1:iOS; 2:Android）
buildIsFirst	Integer	是否是第一个 App（1:是; 2:否）
buildIsLastest	Integer	是否是最新版（1:是; 2:否）
buildFileSize	Integer	App 文件大小
buildName	String	应用名称
iconUrl	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 个字符用 `/` 连接
buildDescription	String	应用介绍
buildUpdateDescription	String	应用更新说明
buildScreenShots	String	应用截图的 key，访问地址为 `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildScreenshotsUrl	Array	应用截图地址
buildShortcutUrl	String	应用短链接
buildCates	String	应用分类，多个分类用 `,` 号隔开
buildQRCodeURL	String	应用二维码地址
buildCreated	String	应用上传时间
buildUpdated	String	应用更新时间
otherApps	Array	历史版本列表，元素字段见下表
otherAppsCount	Integer	历史版本数量
todayDownloadCount	Integer	今日应用下载总次数
todayBuildDownloadCount	Integer	今日版本下载总次数

历史版本（otherApps 数组元素）字段：

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildName	String	应用名称
buildVersion	String	版本号，默认为 1.0
buildBuildVersion	Integer	蒲公英生成的用于区分历史版本的 build 号
buildCreated	String	应用上传时间
buildUpdated	String	应用更新时间

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildFileSize": 12345678,
    "buildName": "示例应用",
    "iconUrl": "https://cdn-app-icon2.pgyer.com/1/2/3/a/b/123abcdefaaa",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildIcon": "123abcdefaaa",
    "buildDescription": "示例介绍",
    "buildUpdateDescription": "修复若干问题",
    "buildScreenShots": "",
    "buildScreenshotsUrl": [],
    "buildShortcutUrl": "abcd",
    "buildCates": "工具,效率",
    "buildQRCodeURL": "https://www.pgyer.com/app/qrcode/abcd",
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00",
    "otherApps": [
      {
        "buildKey": "a1b2c3d4e5f5",
        "buildName": "示例应用",
        "buildVersion": "1.0",
        "buildBuildVersion": 4,
        "buildCreated": "2024-12-01 10:00:00",
        "buildUpdated": "2024-12-01 10:05:00"
      }
    ],
    "otherAppsCount": 4,
    "todayDownloadCount": 12,
    "todayBuildDownloadCount": 8
  }
}

修改 App 详细信息（更新所有版本）

修改某个 App 的详细信息，对该 App 下的所有版本生效。

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

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
appKey	String	是	见 appKey
buildShortcutUrl	String	否	应用短链接地址
buildInstallType	Integer	是	应用安装方式（2:密码安装; 3:邀请安装）
buildPassword	String	否	安装密码（`buildInstallType` 为 2 时使用）
appIsInstallDate	Integer	否	是否设置有效期（1:是; 2:否）
appInstallStartDate	String	否	有效期开始时间（`appIsInstallDate` 为 1 时使用）
appInstallEndDate	String	否	有效期结束时间（`appIsInstallDate` 为 1 时使用）
appLang	Integer	否	语言设置（1:中文; 2:英文; 3:自动）
buildVersionType	Integer	否	Build 版本号设置（1:使用蒲公英生成的自增 Build 版本号; 2:使用 App 本身的 Build 版本号）
appAutoSync	Integer	否	是否自动同步 App 信息（1:是; 2:否）
appShowPgyerCopyright	Integer	否	是否在安装页面显示蒲公英版权信息（1:是; 2:否）
buildQrcodeShowAppIcon	Integer	否	二维码是否显示应用图标（1:是; 2:否）
appFeedbackStatus	Integer	否	是否开启反馈（1:是; 2:否）
buildTemplate	String	否	设置模版，可选值：`classic`、`fashion`、`gray`、`green`、`colorful`

返回数据

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildType	Integer	应用类型（1:iOS; 2:Android）
buildIsFirst	Integer	是否是第一个 App（1:是; 2:否）
buildIsLastest	Integer	是否是最新版（1:是; 2:否）
buildFileSize	Integer	App 文件大小
buildName	String	应用名称
buildPassword	String	应用安装密码
buildVersion	String	版本号，默认为 1.0
buildVersionNo	String	上传包的版本编号，默认为 1
buildQrcodeShowAppIcon	Integer	是否显示二维码中的图标（1:是; 2:否）
buildVersionType	Integer	是否使用蒲公英版本号（1:是; 2:否）
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 个字符用 `/` 连接
buildDescription	String	应用介绍
buildUpdateDescription	String	应用更新说明
buildScreenShots	String	应用截图的 key，访问地址为 `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildShortcutUrl	String	应用短链接
buildIsAcceptFeedback	Integer	是否开启反馈（1:是; 2:否）
buildTemplate	String	模版
buildInstallType	Integer	应用安装方式（2:密码安装; 3:邀请安装）
buildManuallyBlocked	Integer	是否被屏蔽（1:是; 2:否）
buildIsPlaceholder	Integer	是否是空应用（1:是; 2:否）
buildCreated	String	应用上传时间
buildUpdated	String	应用更新时间
buildQRCodeURL	String	应用二维码地址
isOwner	Integer	是否是自己的应用（1:是; 2:否）
isJoin	Integer	是否是参与的应用（1:是; 2:否）
appExpiredDate	String	App 过期时间
appExpiredStatus	Integer	是否即将过期（1:是; 2:否）
otherApps	Array	其他版本
otherAppsCount	Integer	版本数
todayDownloadCount	Integer	今日下载数
appKey	String	App 组的 Key
appAutoSync	Integer	是否同步应用市场（1:是; 2:否）
appShowPgyerCopyright	Integer	是否显示蒲公英版权（1:是; 2:否）
appDownloadPay	Integer	见 `appDownloadPay` 参数对应的金额或其含义
appDownloadDescription	String	应用下载说明
appLang	Integer	应用语言（1:中文; 2:英文; 3:自动）
appIsTestFlight	Integer	是否是 TestFlight 应用（1:是; 2:否）
appIsInstallDate	Integer	是否有安装时间限制（1:是; 2:否）
appInstallStartDate	String	安装开始时间
appInstallEndDate	String	安装结束时间
appFeedbackStatus	Integer	是否开启反馈（1:是; 2:否）
isMerged	Integer	是否已合并（1:是; 2:否）
mergeAppInfo	Array	合并的应用信息

{
  "code": 0,
  "message": "",
  "data": {
    "appKey": "x1y2z3",
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildName": "示例应用",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildInstallType": 2,
    "buildPassword": "123456",
    "buildShortcutUrl": "abcd",
    "buildTemplate": "classic",
    "appIsInstallDate": 1,
    "appInstallStartDate": "2025-01-01",
    "appInstallEndDate": "2025-12-31",
    "appLang": 1,
    "appFeedbackStatus": 1,
    "buildQrcodeShowAppIcon": 1,
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00"
  }
}

上述示例仅列出常用字段，完整字段请见「字段说明」。

修改 App 详细信息（更新指定版本）

修改某个指定版本的 App 详细信息。

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

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
userKey	String	是	用户 Key，用来标识当前用户的身份。可在 API 信息页面中查看
buildKey	String	否	见 buildKey
screenshot	File	否	应用截图
buildShortcutUrl	String	否	应用短链接地址
buildUpdateDescription	String	否	应用更新说明。传值为空则更新为空
buildDescription	String	否	应用说明。传值为空则更新为空
buildPassword	String	否	设置应用密码。传值为空则更新为空
buildVersion	String	否	版本号，默认为 1.0
buildInstallType	Integer	否	应用安装方式

返回数据

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildType	Integer	应用类型（1:iOS; 2:Android）
buildIsFirst	Integer	是否是第一个 App（1:是; 2:否）
buildIsLastest	Integer	是否是最新版（1:是; 2:否）
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 个字符用 `/` 连接
buildDescription	String	应用介绍
buildUpdateDescription	String	应用更新说明
buildScreenShots	String	应用截图的 key，访问地址为 `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildShortcutUrl	String	应用短链接
buildCreated	String	应用上传时间
buildUpdated	String	应用更新时间

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildFileSize": 12345678,
    "buildName": "示例应用",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildIcon": "123abcdefaaa",
    "buildDescription": "示例介绍",
    "buildUpdateDescription": "修复若干问题",
    "buildScreenShots": "",
    "buildShortcutUrl": "abcd",
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00"
  }
}

通过短链接获取 App 信息

通过短链接查询对应 App 的基础信息。

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

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
buildShortcutUrl	String	是	应用短链接。例如 `pgyer.com/PgY8`，只需传入 `PgY8`

返回数据

参数	类型	说明
buildKey	String	Build Key，唯一标识应用的索引 ID
buildIsFirst	Integer	是否是第一个 App（1:是; 2:否）
buildIsLastest	Integer	是否是最新版（1:是; 2:否）
buildType	Integer	应用类型（1:iOS; 2:Android）
buildFileName	String	上传的应用文件名
buildFileSize	Integer	App 文件大小
buildName	String	应用名称
buildVersion	String	版本号，默认为 1.0
buildVersionNo	String	上传包的版本编号，默认为 1
buildBuildVersion	Integer	蒲公英生成的用于区分历史版本的 build 号
buildIdentifier	String	应用程序包名，iOS 为 BundleId，Android 为包名
buildCreated	String	应用上传时间
buildDescription	String	应用介绍
buildUpdateDescription	String	应用更新说明
buildShortcutUrl	String	应用短链接
buildScreenShots	String	应用截图的 key，访问地址为 `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildType": 2,
    "buildFileName": "app-release.apk",
    "buildFileSize": 12345678,
    "buildName": "示例应用",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildCreated": "2025-01-01 10:00:00",
    "buildDescription": "示例介绍",
    "buildUpdateDescription": "修复若干问题",
    "buildShortcutUrl": "PgY8",
    "buildScreenShots": ""
  }
}

查看自己上传的应用

分页获取当前账户下上传的应用列表。

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

请求参数

参数名	类型	必填	说明
_api_key	String	是	API Key，请见鉴权说明
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	应用上传时间
appKey	String	表示一个 App 组的唯一 Key

{
  "code": 0,
  "message": "",
  "data": [
    {
      "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",
      "appKey": "x1y2z3"
    }
  ]
}

本页目录