接口说明

利用蒲公英提供的接口,第三方开发者可以把蒲公英提供的应用上传托管、安装等功能,接入到自己的应用中,并且可以根据数据接口,获取蒲公英提供的各种应用数据,以方便开发者更容易的进行内测应用的分发。


  1. 除特别说明,所有数据API的请求方式均为HTTP POST方式。
  2. 获取图片等资源文件接口的请求方式为HTTP GET
  3. API接口返回数据格式为JSON。
  4. 所有接口请求时,必须包含参数_api_key,以便识别接口身份。点击获取_api_key

示例代码

PHP调用接口示例(查看广场的应用):

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'http://www.pgyer.com/apiv1/app/listAll');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'type=ios&_api_key=&page=1');
$response = curl_exec($curl);
if(curl_errno($curl)){
    echo curl_error($curl);
}
curl_close($curl);
$jsonData = json_decode($response, true);
print_r($jsonData);

上传App

通过该接口上传App到蒲公英,上传时,请使用POST方式,其中enctype为"multipart/form-data"

API地址

POST http://www.pgyer.com/apiv1/app/upload

POST参数

参数 说明
uKey 用户Key 点击获取uKey
_api_key API Key 点击获取API Key
file 需要上传的ipa或者apk文件
publishRange (ipa上传时为必填) 填写发布范围,值为(1,2,3),1:企业发布,2:直接发布,3:只有我安装
isPublishToPublic (选填) 是否发布到广场,值为(1,2),1:发布到广场,2:不发布到广场。默认为不发布到广场

返回数据

参数 说明
appKey App Key
userKey User Key
appType 应用类型(1:iOS; 2:Android)
appIsFirst 是否是第一个App(1:是; 2:否)
appIsLastest 是否是最新版(1:是; 2:否)
appFileSize App 文件大小
appName App 名称
appVersion 版本号
appVersionNo 适用于Android的版本编号,iOS始终为0
appBuildVersion 蒲公英生成的用于区分历史版本的build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appDescription 应用介绍
appUpdateDescription 应用更新说明
appScreenShots 应用截图的key,获取地址为 http://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key]
appShortcutUrl 应用短链接
appCreated 应用上传时间
appUpdated 应用更新时间

安装App

通过该接口可以直接使用手机安装App,请使用GET方式。该接口仅在手机上可用,使用手机浏览器请求该地址即可开始安装。

API地址

GET http://www.pgyer.com/apiv1/app/install

GET参数

参数 说明
aKey App Key (App Key是唯一标识应用的索引ID,可以通过短链接接口获取,或者我的应用接口获取)
_api_key API Key 点击获取API Key
password (选填)当应用需要安装密码时,请传入应用安装密码

返回数据

接口会根据应用的类型(iOS或Android),自动使用相应的的安装方式来安装应用。

获取App详细信息

API地址

POST http://www.pgyer.com/apiv1/app/view

POST参数

参数 说明
aKey App Key (App Key是唯一标识应用的索引ID,可以通过短链接接口获取,或者我的应用接口获取)
uKey (选填) 用户Key 点击获取uKey
_api_key API Key 点击获取API Key

返回数据

应用详情返回参数 说明
appKey App Key
userKey User Key
appType 应用类型(1:iOS; 2:Android)
appIsFirst 是否是第一个App(1:是; 2:否)
appIsLastest 是否是最新版(1:是; 2:否)
appFileSize App 文件大小
appName App 名称
appVersion 版本号
appVersionNo 适用于Android的版本编号,iOS始终为0
appBuildVersion 蒲公英生成的用于区分历史版本的build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appDescription 应用介绍
appUpdateDescription 应用更新说明
appScreenShots 应用截图的key,获取地址为 http://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key]
appShortcutUrl 应用短链接
appCreated 应用上传时间
appUpdated 应用更新时间
历史版本返回参数 说明
appKey App Key
userKey User Key
appName 应用名称
appVersion 应用版本
appBuildVersion 蒲公英生成的用于区分历史版本的build号
appCreated 应用上传时间
appUpdated 应用更新时间
应用反馈返回参数 说明
userKey User Key
commentContent 反馈内容
commentImageKeys 反馈中的截图key,访问地址为:http://app-screenshot.pgyer.com/image/view/comment_screenshot/[反馈中的截图key]
appBuildVersion 蒲公英生成的用于区分历史版本的build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appCreated 应用上传时间
appUpdated 应用更新时间

修改App详细信息

API地址

POST http://www.pgyer.com/apiv1/app/update

POST参数

参数 说明
aKey App Key (App Key是唯一标识应用的索引ID,可以通过短链接接口获取,或者我的应用接口获取)
uKey 用户Key 点击获取uKey
_api_key API Key 点击获取API Key
appName (选填) 应用名称
appShortcutUrl (选填) 应用短链接地址
appUpdateDescription (选填,传值为空则更新为空) 应用更新说明
appDescription (选填,传值为空则更新为空) 应用说明
appPassword (选填,传值为空则更新为空) 设置应用密码
appVersion (选填) 应用版本信息
appScreenshots (选填,传值为空则更新为空) 应用截图Key

返回数据

返回参数 说明
appKey App Key
userKey User Key
appType 应用类型(1:iOS; 2:Android)
appIsFirst 是否是第一个App(1:是; 2:否)
appIsLastest 是否是最新版(1:是; 2:否)
appFileSize App 文件大小
appName App 名称
appVersion 版本号
appVersionNo 适用于Android的版本编号,iOS始终为0
appBuildVersion 蒲公英生成的用于区分历史版本的build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appDescription 应用介绍
appUpdateDescription 应用更新说明
appScreenShots 应用截图的key,获取地址为 http://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key]
appShortcutUrl 应用短链接
appCreated 应用上传时间
appUpdated 应用更新时间

获取App所有版本

API地址

POST http://www.pgyer.com/apiv1/app/builds

POST参数

参数 说明
aKey App Key (App Key是唯一标识应用的索引ID,可以通过短链接接口获取,或者我的应用接口获取)
page 历史版本的分页页数
_api_key API Key 点击获取API Key

返回数据

返回参数 说明
appKey 返回应用最新build的App Key
appType 应用类型(1:iOS; 2:Android)
appFileSize 上传的应用文件大小
appName 应用的名称
appVersion 应用的版本号
appVersionNo 应用的版本值,适用于Android
appBuildVersion 应用在蒲公英的Build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appCreated 返回应用的上传日期

上传App截图

API地址

POST http://www.pgyer.com/apiv1/app/uploadScreenshot

POST参数

参数 说明
aKey App Key (App Key是唯一标识应用的索引ID,可以通过短链接接口获取,或者我的应用接口获取)
_api_key API Key 点击获取API Key
image 需要上传的截图,最大可以上传5张

返回数据

返回参数 说明
keys App上传后所有的截图key(逗号分开),获取地址为 http://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key]

验证App短链接

API地址

POST http://www.pgyer.com/apiv1/app/getAppKeyByShortcut

POST参数

参数 说明
shortcut 应用短链接,例如pgyer.com/PgY8,只需要传入PgY8参数即可
_api_key API Key 点击获取API Key

返回数据

应用详情返回参数 说明
appKey 返回应用最新build的App Key

查看广场的应用

API地址

POST http://www.pgyer.com/apiv1/app/listAll

POST参数

参数 说明
type (选填) type: ios 则只返回iOS的广场应用列表,type: android 则只返回Android的广场应用列表。不填则返回所有
page (选填) 数字1 - 5页,最多只显示5页,每页20个应用
_api_key API Key 点击获取API Key

返回数据

返回参数 说明
appKey 返回应用最新build的App Key
appType 应用类型(1:iOS; 2:Android)
appFileSize 上传的应用文件大小
appName 应用的名称
appVersion 应用的版本号
appVersionNo 应用的版本值,适用于Android
appBuildVersion 应用在蒲公英的Build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appCreated 返回应用的上传日期

查看自己上传的应用

API地址

POST http://www.pgyer.com/apiv1/user/listMyPublished

POST参数

参数 说明
uKey 用户Key 点击获取uKey
page (选填) 填写数字页数
_api_key API Key 点击获取API Key

返回数据

返回参数 说明
appKey 返回应用最新build的App Key
appType 应用类型(1:iOS; 2:Android)
appFileSize 上传的应用文件大小
appName 应用的名称
appVersion 应用的版本号
appVersionNo 应用的版本值,适用于Android
appBuildVersion 应用在蒲公英的Build号
appIdentifier 应用程序包名,iOS为BundleId,Android为包名
appIcon 应用的Icon图标key,访问地址为 http://appicon.pgyer.com/image/view/app_icons/[应用的Icon图标key]
appCreated 返回应用的上传日期