蒲公英 -凯发k8地址
接口说明
利用蒲公英提供的接口,第三方开发者可以把蒲公英提供的应用上传托管、安装等功能,接入到自己的应用中,并且可以根据数据接口,获取蒲公英提供的各种应用数据,以方便开发者更容易的进行内测应用的分发。
- 除特别说明,所有数据api的请求方式均为http post方式。
- 获取图片等资源文件接口的请求方式为http get
- api接口返回数据格式为json。
- 所有接口请求时,必须包含参数_api_key,以便识别接口身份。
蒲公英现已推出api 2.0,推荐开发者使用,api 1.0版本将不再维护和更新。
常规参数说明
参数 |
别称 |
说明 |
_api_key |
api key |
api key,用来识别api调用者的身份,如不特别说明,每个接口中都需要含有此参数。对于同一个蒲公英的注册用户来说,这个值是固定的。 |
ukey |
user key |
用户key,用来标识当前用户的身份,对于同一个蒲公英的注册用户来说,这个值是固定的。 |
aid |
app id |
表示一个app组的唯一id。例如,名称为"微信"的app上传了三个版本,那么这三个版本为一个app组,该参数表示这个组的id。这个值可以在应用管理后台中看到。 |
akey |
app key |
代表一个具体的app的唯一标识。例如,名称为"微信"的app上传了三个版本,那么这三个版本具有不同的 akey,这个值一般是通过其他接口返回的。 |
示例代码
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);
// output $jsondata ...
上传app
通过该接口,开发者可以直接上传 app 到蒲公英。上传时,请使用 http post 方式,其中 enctype 为 "multipart/form-data"
api地址
post https://upload.pgyer.com/apiv1/app/upload
post参数
参数 |
类型 |
说明 |
ukey |
string |
(必填) 用户key |
_api_key |
string |
(必填) api key |
file |
file |
(必填) 需要上传的ipa或者apk文件 |
installtype |
integer |
(选填)应用安装方式,值为(1,2,3)。1:公开,2:密码安装,3:邀请安装。默认为1公开 |
password |
string |
(选填) 设置app安装密码,如果不想设置密码,请传空字符串,或不传。 |
updatedescription |
string |
(选填) 版本更新描述,请传空字符串,或不传。 |
channelshortcut |
string |
(选填)所需更新的指定渠道的下载短链接,只可指定一个渠道,字符串型,如:abcd。 |
返回数据
参数 |
类型 |
说明 |
appkey |
string |
app key |
userkey |
string |
user key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appisfirst |
integer |
是否是第一个app(1:是; 2:否) |
appislastest |
integer |
是否是最新版(1:是; 2:否) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appdescription |
string |
应用介绍 |
appupdatedescription |
string |
应用更新说明 |
appscreenshots |
string |
应用截图的key,获取地址为 https://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key] |
appshortcuturl |
string |
应用短链接 |
appqrcodeurl |
string |
应用二维码地址 |
appcreated |
string |
应用上传时间 |
appupdated |
string |
应用更新时间 |
上传app示例
使用linux下的crul命令上传app示例:
curl -f "[email protected]/tmp/example.ipa" -f "ukey=" -f "_api_key=" https://upload.pgyer.com/apiv1/app/upload
请根据开发者自己的账号,将其中的 ukey 和 _api_key 的值替换为相应的值。
安装app
通过该接口可以直接使用手机安装 app,请使用 http get 方式。该接口仅在手机上可用,使用手机浏览器请求该地址即可开始安装。
api地址
get http://www.pgyer.com/apiv1/app/install
get参数
参数 |
说明 |
akey |
app key (app key是唯一标识应用的索引id,可以通过短链接接口获取,或者我的应用接口获取) |
_api_key |
api key |
password |
(选填) 当应用需要安装密码时,请传入应用安装密码 |
返回数据
接口会根据应用的类型(ios或android),自动使用相应的的安装方式来安装应用。
示例代码
http://www.pgyer.com/apiv1/app/install?_api_key=&akey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456
ios应用内安装
ios应用内安装接口,可以实现用户安装应用时,无需打开浏览器,即可直接安装的效果。接口地址:
itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{akey}
请将其中的{akey}
换成app的key,不包含大括号。
示例代码
web:
post参数
参数 |
类型 |
说明 |
akey |
string |
(app key是唯一标识应用的索引id,可以通过短链接接口获取,或者我的应用接口获取) |
ukey |
string |
(选填) 用户key |
_api_key |
string |
api key |
返回数据
应用详情返回参数 |
类型 |
说明 |
appkey |
string |
app key |
userkey |
string |
user key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appisfirst |
integer |
是否是第一个app(1:是; 2:否) |
appislastest |
integer |
是否是最新版(1:是; 2:否) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appdescription |
string |
应用介绍 |
appupdatedescription |
string |
应用更新说明 |
appscreenshots |
string |
应用截图的key,获取地址为 https://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key] |
appshortcuturl |
string |
应用短链接 |
appqrcodeurl |
string |
应用二维码地址 |
appcreated |
string |
应用上传时间 |
appupdated |
string |
应用更新时间 |
历史版本返回参数 |
类型 |
说明 |
appkey |
string |
app key |
userkey |
string |
user key |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appcreated |
string |
应用上传时间 |
appupdated |
string |
应用更新时间 |
应用反馈返回参数 |
类型 |
说明 |
userkey |
integer |
user key |
commentcontent |
integer |
反馈内容 |
commentimagekeys |
integer |
反馈中的截图key,访问地址为:https://app-screenshot.pgyer.com/image/view/comment_screenshot/[反馈中的截图key] |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
integer |
应用程序包名,ios为bundleid,android为包名 |
appcreated |
integer |
应用上传时间 |
appupdated |
integer |
应用更新时间 |
获取app组详细信息
同一个 app 的不同版本,蒲公英会将它们合并起来,形成一个 app 的集合,这个集合我们称之为一个"app组"。对于一个"app组",会有一个唯一的 app id 与之对应。该接口用来获取 app 组的详细信息。
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
_api_key |
string |
api key |
返回数据
应用详情返回参数 |
类型 |
说明 |
appkey |
string |
app key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appisfirst |
integer |
是否是第一个app(1:是; 2:否) |
appislastest |
integer |
是否是最新版(1:是; 2:否) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appdescription |
string |
应用介绍 |
appupdatedescription |
string |
应用更新说明 |
appscreenshots |
string |
应用截图的key,获取地址为 https://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key] |
appshortcuturl |
string |
应用短链接 |
appqrcodeurl |
string |
应用二维码地址 |
appcreated |
string |
应用上传时间 |
appupdated |
string |
应用更新时间 |
修改app详细信息
api地址
post
post参数
参数 |
类型 |
说明 |
akey |
string |
app key (app key是唯一标识应用的索引id,可以通过短链接接口获取,或者我的应用接口获取) |
ukey |
string |
用户key |
_api_key |
string |
api key |
appname |
string |
(选填) 应用名称 |
appshortcuturl |
string |
(选填) 应用短链接地址 |
appupdatedescription |
string |
(选填,传值为空则更新为空) 应用更新说明 |
appdescription |
string |
(选填,传值为空则更新为空) 应用说明 |
apppassword |
string |
(选填,传值为空则更新为空) 设置应用密码 |
appversion |
string |
(选填) 应用版本信息 |
appscreenshots |
string |
(选填,传值为空则更新为空) 应用截图key |
返回数据
返回参数 |
类型 |
说明 |
appkey |
string |
app key |
userkey |
string |
user key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appisfirst |
integer |
是否是第一个app(1:是; 2:否) |
appislastest |
integer |
是否是最新版(1:是; 2:否) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appdescription |
string |
应用介绍 |
appupdatedescription |
string |
应用更新说明 |
appscreenshots |
string |
应用截图的key,获取地址为 https://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key] |
appshortcuturl |
string |
应用短链接 |
appqrcodeurl |
string |
应用二维码地址 |
appcreated |
string |
应用上传时间 |
appupdated |
string |
应用更新时间 |
获取app所有版本
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
page |
integer |
历史版本分页页数 |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
appkey |
string |
返回应用最新build的app key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appcreated |
string |
应用上传时间 |
上传app截图
api地址
post
post参数
参数 |
类型 |
说明 |
akey |
string |
app key (app key是唯一标识应用的索引id,可以通过短链接接口获取,或者我的应用接口获取) |
_api_key |
string |
api key |
image |
file |
需要上传的截图,最大可以上传5张 |
返回数据
返回参数 |
类型 |
说明 |
keys |
string |
app上传后所有的截图key(逗号分开),获取地址为 https://app-screenshot.pgyer.com/image/view/app_screenshots/[应用截图的key] |
使用短链接获取app信息
api地址
post
post参数
参数 |
类型 |
说明 |
shortcut |
string |
应用短链接,例如pgyer.com/pgy8,只需要传入pgy8参数即可 |
_api_key |
string |
api key |
返回数据
应用详情返回参数 |
类型 |
说明 |
appkey |
string |
返回应用最新build的app key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appfilename |
string |
上传的应用文件名 |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appcreated |
string |
应用上传时间 |
查看自己上传的应用
api地址
post
post参数
参数 |
类型 |
说明 |
ukey |
string |
用户key |
page |
integer |
(选填) 填写数字页数 |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
appkey |
string |
返回应用最新build的app key |
apptype |
integer |
应用类型(1:ios; 2:android) |
appfilesize |
integer |
app 文件大小 |
appname |
string |
应用名称 |
appversion |
string |
版本号 |
appversionno |
integer |
适用于android的版本编号,ios始终为0 |
appbuildversion |
integer |
蒲公英生成的用于区分历史版本的build号 |
appidentifier |
string |
应用程序包名,ios为bundleid,android为包名 |
appicon |
string |
应用的icon图标key,访问地址为 https://appicon.pgyer.com/image/view/app_icons/[应用的icon图标key] |
appcreated |
string |
应用上传时间 |
列出用户的app分组
这里说的分组,指的是开发者在「应用管理」-「我的分组」中设置的app分组。
api地址
post
post参数
参数 |
类型 |
说明 |
ukey |
string |
用户key |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
userappgroupname |
string |
app分组名称 |
userappgroupkey |
string |
app分组唯一标识key |
userappgroupshortcuturl |
string |
app分组的短链接 |
userappgroupdescription |
string |
app分组的描述 |
userappgroupcount |
string |
app分组中app的数量 |
userappcreated |
string |
app分组的创建时间 |
查看用户的app分组
这里说的分组,指的是开发者在「应用管理」-「我的分组」中设置的app分组。
这个接口会返回某个app分组的详细信息,同时也返回这个分组里面包含的app信息(只列出最新版本)。
api地址
post
post参数
参数 |
类型 |
说明 |
userappgroupkey |
string |
用户app分组的key。可以通过 userappgroup/view 接口获取。 |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
userappgroupname |
string |
app分组名称 |
userappgroupkey |
string |
app分组唯一标识key |
userappgroupshortcuturl |
string |
app分组的短链接 |
userappgroupdescription |
string |
app分组的描述 |
userappgroupcount |
string |
app分组中app的数量 |
userappcreated |
string |
app分组的创建时间 |
apps |
array |
包含的app信息(返回最新版本信息) |
查看app反馈信息列表
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
_api_key |
string |
api key |
page |
integer |
分页页数 |
返回数据
返回参数 |
类型 |
说明 |
feedbackcontent |
string |
反馈内容 |
feedbackimages |
array |
反馈信息中图片地址 |
feedbackvoice |
string |
录音文件地址 |
feedbackfrom |
string |
反馈信息来源 |
feedbackprocess |
integer |
反馈处理状态(1:已处理; 2:未处理) |
feedbackcreated |
string |
反馈创建时间 |
查看app反馈信息详情
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
feedbackkey |
string |
反馈信息的key,可以通过feedbacklistall接口得到 |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
feedbackcontent |
string |
反馈内容 |
feedbackimages |
array |
反馈信息中图片地址 |
feedbackvoice |
string |
录音文件地址 |
feedbackdevicename |
string |
设备名称 |
feedbackosversion |
string |
手机系统版本 |
feedbackostype |
integer |
手机系统类型(1:ios; 2:android) |
feedbackosjailbroken |
integer |
手机是否越狱或root(1:是; 2:否) |
feedbackfreeram |
string |
手机剩余内存大小 |
feedbackfreespace |
string |
手机剩余磁盘空间大小 |
feedbacknetwork |
string |
手机网络 |
feedbacksdkversion |
string |
sdk 版本 |
feedbackfrom |
string |
反馈信息来源 |
feedbackprocess |
integer |
反馈处理状态(1:已处理; 2:未处理) |
apptype |
integer |
应用类型 (1:ios; 2:android) |
appname |
string |
应用名称 |
feedbackcreated |
string |
反馈创建时间 |
查看应用crash log 列表
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
_api_key |
string |
api key |
page |
integer |
分页页数 |
返回数据
返回参数 |
类型 |
说明 |
sdkcrashgroupcount |
integer |
crash 数量 |
sdkcrashgrouptitle |
string |
crash 标题 |
sdkcrashgrouppattern |
string |
crash pattern |
sdkcrashgroupdescribe |
string |
crash 描述 |
sdkcrashgroupappversion |
string |
crash app 版本 |
sdkcrashgroupprocess |
string |
crash 处理状态 |
sdkcrashgroupid |
integer |
crashgroupid |
sdkcrashgroupcreated |
string |
crash 创建时间 |
查看应用crash log 详情
api地址
post
post参数
参数 |
类型 |
说明 |
aid |
string |
app id |
sdkcrashgroupid |
integer |
sdkcrashgroupid, 可以通过crashlistall获得某条crash的sdkcrashgroupid |
_api_key |
string |
api key |
返回数据
返回参数 |
类型 |
说明 |
sdkcrashgrouplog |
string |
crash log |
sdkcrashgroupcount |
integer |
crash 数量 |
sdkcrashgrouptitle |
string |
crash 标题 |
sdkcrashgrouppattern |
string |
crash pattern |
sdkcrashgroupdescribe |
string |
crash 描述 |
sdkcrashgroupappversion |
string |
crash app 版本 |
sdkcrashgroupissymbolicated |
string |
crash log 是否符号化 |
sdkcrashgroupisreaded |
string |
crash 是否已读 |
sdkcrashgroupprocess |
string |
crash 处理状态 |
sdkcrashgroupviewstatus |
string |
crash 查看状态 |
deviceaffectlist |
array |
影响设备情况 |
sdkcrashgroupcreated |
string |
crash 创建时间 |