蒲公英文档中心

安装应用

通过 API 直接触发蒲公英平台上 App 的安装,包含通用安装接口与 iOS 应用内安装方式。

本页介绍通过 API 直接触发 App 安装的两种方式:通用安装接口与 iOS 应用内安装。

安装 App

通过该接口,您可以直接将安装蒲公英平台上 App 的功能集成到自己的系统中,而不再需要通过蒲公英提供的 App 下载 Web 页。

GEThttps://www.pgyer.com/apiv2/app/install

请使用 GET 方式请求该接口,且必须在 iOS 或 Android 系统中使用。

该接口为付费接口,目前每个用户每天赠送 200 次免费请求。超出后将按 ¥0.03/次 的价格从蒲公英账户余额中扣除。当账户余额不足时,该接口会返回错误。使用本接口时请保持账号余额充足。

请求参数

参数名类型必填说明
_api_keyStringAPI Key,请见 鉴权说明
appKeyString条件必填支持传入 appKey 或应用短链接,此时为安装 App 最新版本。buildKey 和 appKey 不能同时为空
buildKeyString条件必填buildKey,安装 App 具体的某个版本。buildKey 和 appKey 不能同时为空
buildPasswordString当应用需要安装密码时,请传入应用安装密码

返回数据

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

请求示例

https://www.pgyer.com/apiv2/app/install?_api_key={_api_key}&buildKey={buildKey}&buildPassword={buildPassword}

iOS 应用内安装

iOS 应用内安装通过 itms-services:// URL 协议实现,可以让用户不用打开浏览器就能直接触发安装。

普通安装地址:

itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{buildKey}

密码安装地址:

itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{buildKey}?password={password}

将其中的 {buildKey} 替换为 App 的 buildKey,{password} 替换为 App 的安装密码(不包含大括号)。

调用示例

Web 链接:

<a href="itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{buildKey}">安装</a>

iOS 客户端:

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{buildKey}"]];

或直接调用安装接口:

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.pgyer.com/apiv2/app/install?_api_key={_api_key}&buildKey={buildKey}&buildPassword={buildPassword}"]];

本页目录