接口說明
利用蒲公英提供的接口，第三方開發者可以把蒲公英提供的應用上傳托管、安裝等功能，接入到自己的應用中，并且可以根據數據接口，獲取蒲公英提供的各種應用數據，以方便開發者更容易的進行內測應用的分發。
本頁面展示的是最新版本 API 2.0，舊版本 API 1.0 將不再維護和更新。
鑒權說明
大部分 API 都是需要鑒權的，開發者可以登錄蒲公英后臺的 API 信息頁面 獲取 API Key，然后在需要鑒權的 API 中，以 POST 方式傳入以下參數即可：
| 參數 |
說明 |
| _api_key |
API Key，用來識別API調用者的身份，如不特別說明，每個接口中都需要含有此參數。對于同一個蒲公英的注冊用戶來說，這個值是固定的。 |
API 調用說明
開發者發送數據格式請設置為 Content-Type: application/x-www-form-urlencoded，除非特別說明時，請求方式均為 POST 方式，返回數據格式為 JSON。以下是通用參數概念解釋：
| 參數 |
說明 |
| appKey |
獨立 App 的唯一標識符。例如某 App 上傳了三個版本，那么這三個版本具有相同的 appKey。獲取方式：可以在 App 管理頁面中找到 appKey，也可以在某個 API 返回的結果中獲取到 |
| buildKey |
獨立 App 版本的唯一標識符。例如某 App 上傳了三個版本，那么這三個版本具有不同的 buildKey。獲取方式：可以在某些 API 返回的結果中獲取 |
快速上傳 App (新版)
通過 API 上傳 App 到蒲公英平臺。代碼調用示例：https://github.com/PGYER/upload-app-api-example
1、獲取上傳的 token
通過該接口，開發者可以獲取預上傳 url 和相關的簽名參數
API地址
POST http://www.jsjtzm.com/apiv2/app/getCOSToken
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| buildType |
String |
(必填) 需要上傳的應用類型，如果是iOS類型請傳ios或ipa，如果是Android類型請傳android或apk |
| oversea |
Integer |
(選填) 是否使用海外加速上傳，值為：1 使用海外加速上傳，2 國內加速上傳；留空根據 IP 自動判斷海外加速或國內加速 |
| buildInstallType |
Integer |
(選填)應用安裝方式，值為(1,2,3，默認為1 公開安裝)。1：公開安裝，2：密碼安裝，3：邀請安裝 |
| buildPassword |
String |
(選填) 設置App安裝密碼，密碼為空時默認公開安裝 |
| buildDescription |
String |
(選填) 應用介紹，如沒有介紹請傳空字符串，或不傳。 |
| buildUpdateDescription |
String |
(選填) 版本更新描述，請傳空字符串，或不傳。 |
| buildInstallDate |
Integer |
(選填)是否設置安裝有效期，值為：1 設置有效時間， 2 長期有效，如果不填寫不修改上一次的設置 |
| buildInstallStartDate |
String |
(選填)安裝有效期開始時間，字符串型，如：2018-01-01 |
| buildInstallEndDate |
String |
(選填)安裝有效期結束時間，字符串型，如：2018-12-31 |
| buildChannelShortcut |
String |
(選填)所需更新指定的渠道短鏈接，渠道短鏈接須為已創建成功的，并且只可指定一個渠道，字符串型，如：abcd |
返回數據
| 參數 |
類型 |
說明 |
| key |
String |
key 上傳文件存儲標識唯一 key |
| endpoint |
String |
上傳文件的 URL |
| params |
Object |
上傳文件需要的參數，包含signature、x-cos-security-token、key |
2、上傳文件到第上一步獲取的 URL
在這一步中上傳 App 成功后，App 會自動進入服務器后臺隊列繼續后續的發布流程。所以，在這一步中 App 上傳完成后，并不代表 App 已經完成發布。一般來說，一般1分鐘以內就能完成發布。要檢查是否發布完成，請調用下一步中的 API。
API地址
POST 上一步響應中 endpoint 的值
POST參數
| 參數 |
類型 |
說明 |
| key |
String |
(必填) 從上一步響應中得到 |
| signature |
String |
(必填) 從上一步響應中得到 |
| x-cos-security-token |
String |
(必填) 從上一步響應中得到 |
| x-cos-meta-file-name |
String |
(選填) 上傳的原始文件名，如 app-release.apk |
| file |
File |
(必填) App 文件的本地路徑 |
返回數據
如果上傳成功：返回 http 狀態碼為 204 No Content；
如果上傳失敗：返回相應錯誤信息說明
3、檢測應用是否發布完成，并獲取發布應用的信息
API地址
GET http://www.jsjtzm.com/apiv2/app/buildInfo
參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| buildKey |
String |
(必填) 第一步中返回的key |
返回的值分為以下 3 種情況：
發布成功返回數據
| 參數 |
類型 |
說明 |
| 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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildQRCodeURL |
String |
應用二維碼地址 |
| buildCreated |
String |
應用上傳時間 |
| buildUpdated |
String |
應用更新時間 |
發布成功失敗返回數據
| 參數 |
類型 |
說明 |
| code |
Integer |
錯誤碼，1216 應用發布失敗 |
| message |
String |
信息提示 |
正在發布返回數據
| 參數 |
類型 |
說明 |
| code |
Integer |
錯誤碼，1247 應用正在發布中 |
| message |
String |
信息提示 |
如果返回 code = 1246 ，可間隔 3s ~ 5s 重新調用 URL 進行檢測，直到返回成功或失敗。
上傳App (舊版)
本接口上傳速度較慢，建議您使用 快速上傳App 中的方式來替代。
API地址
POST http://www.jsjtzm.com/apiv2/app/upload
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| file |
File |
(必填) 需要上傳的ipa或者apk文件 |
| buildInstallType |
Integer |
(選填)應用安裝方式，值為(1,2,3，默認為1 公開安裝)。1：公開安裝，2：密碼安裝，3：邀請安裝 |
| buildPassword |
String |
(選填) 設置App安裝密碼，密碼為空時默認公開安裝 |
| buildUpdateDescription |
String |
(選填) 版本更新描述，請傳空字符串，或不傳。 |
| buildInstallDate |
Integer |
(選填)是否設置安裝有效期，值為：1 設置有效時間， 2 長期有效，如果不填寫不修改上一次的設置 |
| buildInstallStartDate |
String |
(選填)安裝有效期開始時間，字符串型，如：2018-01-01 |
| buildInstallEndDate |
String |
(選填)安裝有效期結束時間，字符串型，如：2018-12-31 |
| buildChannelShortcut |
String |
(選填)所需更新的指定渠道的下載短鏈接，只可指定一個渠道，字符串型，如：abcd |
返回數據
| 參數 |
類型 |
說明 |
| 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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildQRCodeURL |
String |
應用二維碼地址 |
| buildCreated |
String |
應用上傳時間 |
| buildUpdated |
String |
應用更新時間 |
安裝 App
通過該接口，可以讓開發者直接將安裝蒲公英平臺上的 App 的功能，集成到開發者自己的系統中，而不再需要通過蒲公英提供的 App 下載 Web 頁。開發者需使用 GET 方式請求該接口，且必須在 iOS/Android 系統中使用。
請注意：該接口為付費接口，目前每個用戶每天贈送 200 次免費請求次數，超出后將會按照 ￥0.03/次的價格從蒲公英賬戶余額中扣除，當賬戶余額不足時，該接口會返回錯誤。因此，在使用本接口時，開發者請保持賬號余額充足。
API 地址
GET http://www.jsjtzm.com/apiv2/app/install
參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(buildKey和appKey不能同時為空) 支持傳入 appKey 或應用短鏈接，此時為安裝 App 最新版本 |
| buildKey |
String |
(buildKey和appKey不能同時為空) 請見 buildKey，安裝 App 具體的某個版本 |
| buildPassword |
String |
(選填) 當應用需要安裝密碼時，請傳入應用安裝密碼 |
返回數據
接口會根據應用的類型（iOS或Android），自動使用相應的的安裝方式來安裝應用。
示例代碼
http://www.jsjtzm.com/apiv2/app/install?_api_key=&buildKey={buildKey}&buildPassword={buildPassword}
iOS應用內安裝
iOS應用內安裝接口，可以實現用戶安裝應用時，無需打開瀏覽器，即可直接安裝的效果。接口地址：
itms-services://?action=download-manifest&url=http://www.jsjtzm.com/app/plist/{buildKey}
請將其中的{buildKey}換成App的buildKey，不包含大括號。
示例代碼
Web:
<a href="itms-services://?action=download-manifest&url=http://www.jsjtzm.com/app/plist/{buildKey}">安裝</a>
iOS:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@'itms-services://?action=download-manifest&url=http://www.jsjtzm.com/app/plist/{buildKey}']];
或者:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@'http://www.jsjtzm.com/apiv2/app/install?_api_key=&buildKey={buildKey}&buildPassword={buildPassword}']];
獲取App詳細信息
該接口可以獲取某個 App 的某個具體版本的詳細信息。
API地址
POST http://www.jsjtzm.com/apiv2/app/view
POST參數
| 參數 |
類型 |
說明 |
| _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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
| buildScreenshotsUrl |
array |
應用截圖地址 |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildCates |
String |
應用分類，多個分類用 “,” 號隔開 |
| buildQRCodeURL |
String |
應用二維碼地址 |
| buildCreated |
String |
應用上傳時間 |
| buildUpdated |
String |
應用更新時間 |
| otherApps |
array |
歷史版本 |
| otherAppsCount |
int |
歷史版本數量 |
| 歷史版本返回參數 |
類型 |
說明 |
| buildKey |
String |
Build Key是唯一標識應用的索引ID |
| buildName |
String |
應用名稱 |
| buildVersion |
String |
版本號, 默認為1.0 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildCreated |
String |
應用上傳時間 |
| buildUpdated |
String |
應用更新時間 |
修改 App 詳細信息(更新所有版本)
API 地址
POST http://www.jsjtzm.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 |
(選填)有效期開始時間 （buildInstallDate 為1時使用） |
| appInstallEndDate |
String |
(選填) 有效期結束時間 （buildInstallDate 為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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildQrcodeShowAppIcon |
Integer |
是否顯示二維碼中的圖標（1:是; 2:否） |
| buildVersionType |
Integer |
是否使用蒲公英版本號（1:是; 2:否） |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildIsAcceptFeedback |
Integer |
是否開啟反饋 (1:是;2:否） |
| buildIsUploadCrashlog |
Integer |
是否接受Crash(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 |
合并的應用信息 |
修改App詳細信息
API地址
POST http://www.jsjtzm.com/apiv2/app/updateApp
POST參數
| 參數 |
類型 |
說明 |
| _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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| 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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildCreated |
String |
應用上傳時間 |
| buildUpdated |
String |
應用更新時間 |
獲取App所有版本
API地址
POST http://www.jsjtzm.com/apiv2/app/builds
POST參數
| 參數 |
類型 |
說明 |
| _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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildCreated |
String |
應用上傳時間 |
通過短鏈接獲取App信息
API地址
POST http://www.jsjtzm.com/apiv2/app/getByShortcut
POST參數
| 參數 |
類型 |
說明 |
| _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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildCreated |
String |
應用上傳時間 |
| buildDescription |
String |
應用介紹 |
| buildUpdateDescription |
String |
應用更新說明 |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildScreenShots |
String |
應用截圖的key，獲取地址為 http://www.jsjtzm.com/image/view/app_screenshots/<screenshot_key> |
查看自己上傳的應用
API地址
POST http://www.jsjtzm.com/apiv2/app/listMy
POST參數
| 參數 |
類型 |
說明 |
| _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 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildBuildVersion |
Integer |
蒲公英生成的用于區分歷史版本的build號 |
| buildIdentifier |
String |
應用程序包名，iOS為BundleId，Android為包名 |
| buildIcon |
String |
應用的Icon圖標key，訪問地址為 http://www.jsjtzm.com/image/view/app_icons/<buildIcon> |
| buildCreated |
String |
應用上傳時間 |
| appKey |
String |
表示一個App組的唯一Key。 |
設置最新版本
API地址
POST http://www.jsjtzm.com/apiv2/app/setNewestVersion
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| buildKey |
String |
(選填) 見 buildKey |
返回數據
| 返回參數 |
類型 |
說明 |
| code |
Integer |
Code 碼（1:iOS; 2:Android） |
| message |
String |
處理結果信息 |
取消最新版本
API地址
POST http://www.jsjtzm.com/apiv2/app/cancelNewestVersion
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| buildKey |
String |
(選填) 見 buildKey |
返回數據
| 返回參數 |
類型 |
說明 |
| code |
Integer |
Code 碼（1:iOS; 2:Android） |
| message |
String |
處理結果信息 |
檢測App是否有更新
API地址
POST http://www.jsjtzm.com/apiv2/app/check
POST參數
| 參數 |
類型 |
說明 |
| _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 |
應用安裝地址 |
| buildHaveNewVersion |
Boolean |
是否有新版本 |
| buildVersionNo |
String |
上傳包的版本編號，默認為1 (即編譯的版本號，一般來說，編譯一次會變動一次這個版本號, 在 Android 上叫 Version Code。對于 iOS 來說，是字符串類型；對于 Android 來說是一個整數。例如：1001，28等。) |
| buildVersion |
String |
版本號, 默認為1.0 (是應用向用戶宣傳時候用到的標識，例如：1.1、8.2.1等。) |
| buildShortcutUrl |
String |
應用短鏈接 |
| buildUpdateDescription |
String |
應用更新說明 |
列出用戶的App分組
這里說的分組，指的是開發者在「應用管理」-「我的分組」中設置的App分組。
API地址
POST http://www.jsjtzm.com/apiv2/appGroup/listAll
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
返回數據
| 返回參數 |
類型 |
說明 |
| appGroupName |
String |
App分組名稱 |
| appGroupKey |
String |
App分組唯一標識Key |
| appGroupShortcutURL |
String |
App分組的短鏈接 |
| appGroupDescription |
String |
App分組的描述 |
| appGroupCount |
String |
App分組中App的數量 |
| appCreated |
String |
App分組的創建時間 |
查看用戶的App分組
這里說的分組，指的是開發者在「應用管理」-「我的分組」中設置的App分組。
這個接口會返回某個App分組的詳細信息，同時也返回這個分組里面包含的App信息（只列出最新版本）。
API地址
POST http://www.jsjtzm.com/apiv2/appGroup/view
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appGroupKey |
String |
(必填) 用戶App分組的Key。可以通過 appGroup/listAll 接口獲取。 |
返回數據
| 返回參數 |
類型 |
說明 |
| appGroupName |
String |
App分組名稱 |
| appGroupKey |
String |
App分組唯一標識Key |
| appGroupShortcutURL |
String |
App分組的短鏈接 |
| appGroupDescription |
String |
App分組的描述 |
| appGroupCount |
String |
App分組中App的數量 |
| appCreated |
String |
App分組的創建時間 |
| apps |
Array |
包含的app信息（返回最新版本信息） |
查看App反饋信息列表
API地址
POST http://www.jsjtzm.com/apiv2/feedback/listAll
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(必填) 見 appKey |
| page |
Integer |
(選填) 分頁頁數 |
返回數據
| 返回參數 |
類型 |
說明 |
| feedbackContent |
String |
反饋內容 |
| feedbackImages |
Array |
反饋信息中圖片地址 |
| feedbackVoice |
String |
錄音文件地址 |
| feedbackFrom |
String |
反饋信息來源 |
| feedbackProcess |
Integer |
反饋處理狀態（1:已處理; 2:未處理） |
| feedbackCreated |
String |
反饋創建時間 |
| feedbackKey |
String |
feedbackKey |
查看App反饋信息詳情
API地址
POST http://www.jsjtzm.com/apiv2/feedback/view
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(必填) 見 appKey |
| feedbackKey |
String |
(必填) 反饋信息的Key,可以通過feedbackListAll接口得到 |
返回數據
| 返回參數 |
類型 |
說明 |
| 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:未處理） |
| buildType |
Integer |
應用類型 （1:iOS; 2:Android） |
| buildName |
String |
應用名稱 |
| feedbackCreated |
String |
反饋創建時間 |
查看應用 Crash Log 列表
API地址
POST http://www.jsjtzm.com/apiv2/crash/listAll
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(必填) 見 appKey |
| page |
Integer |
(選填) 分頁頁數 |
返回數據
| 返回參數 |
類型 |
說明 |
| crashCount |
Integer |
Crash 數量 |
| crashTitle |
String |
Crash 標題 |
| crashPattern |
String |
Crash Pattern |
| crashDescribe |
String |
Crash 描述 |
| crashAppVersion |
String |
Crash App 版本 |
| crashProcess |
String |
Crash 處理狀態 |
| crashId |
Integer |
CrashGroupId |
| crashCreated |
String |
Crash 創建時間 |
查看應用 Crash Log 詳情
API地址
POST http://www.jsjtzm.com/apiv2/crash/view
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(必填) 見 appKey |
| crashId |
Integer |
(必填) crashId, 可以通過crashListAll獲得某條crash的crashId |
返回數據
| 返回參數 |
類型 |
說明 |
| crashLog |
String |
Crash Log |
| crashCount |
Integer |
Crash 數量 |
| crashTitle |
String |
Crash 標題 |
| crashPattern |
String |
Crash Pattern |
| crashDescribe |
String |
Crash 描述 |
| crashAppVersion |
String |
Crash App 版本 |
| crashIsSymbolicated |
String |
Crash Log 是否符號化 |
| crashIsReaded |
String |
Crash 是否已讀 |
| crashProcess |
String |
Crash 處理狀態 |
| crashViewStatus |
String |
Crash 查看狀態 |
| deviceAffectList |
Array |
影響設備情況 |
| crashCreated |
String |
Crash 創建時間 |
證書列表
通過該接口，開發者可以直接查看自己的證書管理。
API地址
POST http://www.jsjtzm.com/apiv2/certificate/index
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
返回數據
| 參數 |
類型 |
說明 |
| certificateKey |
String |
證書的唯一標識Key |
| certificateName |
String |
證書名稱 |
| certificateExpired |
Date |
證書的過期時間 |
| certificateCreated |
Date |
證書的上傳時間 |
| certificateStatus |
String |
證書的狀態 |
刪除應用
通過該接口，開發者可以直接刪除自己的應用。
API地址
POST http://www.jsjtzm.com/apiv2/app/deleteApp
POST參數
| 參數 |
類型 |
說明 |
| _api_key |
String |
(必填) API Key，請見 鑒權說明 |
| appKey |
String |
(必填) 見 appKey |
返回數據
| 參數 |
類型 |
說明 |
| code |
int |
code = 0, 刪除成功，否則返回錯誤碼 |
錯誤碼含義
| 錯誤碼 |
說明 |
| 1001 |
_api_key 不能為空 |
| 1002 |
_api_key 錯誤 |
| 1003 |
同步用戶信息到Tracup出錯信息 |
| 1007 |
搜索詞太短 |
| 1008 |
Build Key 和 appKey 不能同時為空 |
| 1009 |
沒有找到該App相關信息 |
| 1010 |
App Key 不能為空 |
| 1011 |
Build Id 不能為空 |
| 1012 |
User key 不能為空 |
| 1013 |
沒有找到該用戶 |
| 1014 |
應用類型不能為空 |
| 1015 |
文件或App類型錯誤 |
| 1016 |
無效的包名 |
| 1017 |
短鏈接已被使用或者不符合規范 |
| 1018 |
App 數量超過套餐的上限 |
| 1019 |
實名認證身份照片不全，請上傳身份證正面、背面及手持身份照片 |
| 1020 |
用戶被禁止上傳 |
| 1021 |
文件無效 |
| 1022 |
文件過大 |
| 1023 |
build key 不能為空 |
| 1024 |
發布范圍超過限制 |
| 1025 |
文件上傳失敗 |
| 1026 |
無效文件，文件類型錯誤 |
| 1027 |
應用名稱長度不符合規范 |
| 1028 |
未找到應用的標識符 |
| 1029 |
短鏈接已被使用或不符合規范 |
| 1030 |
發布企業簽名數量超過套餐最大值 |
| 1031 |
短鏈接不能為空 |
| 1032 |
短鏈接無效 |
| 1033 |
只能修改自己的應用 |
| 1035 |
修改的字段超過限制 |
| 1036 |
修改內容不能為空 |
| 1037 |
圖片必須以數組的形式上傳 |
| 1038 |
圖片數據不能為空 |
| 1039 |
應用截圖最多不能超過5張 |
| 1040 |
應用截圖上傳失敗 |
| 1041 |
應用截圖key不能為空 |
| 1042 |
反饋內容不能為空 |
| 1043 |
反饋內容過長，不能超過200字 |
| 1044 |
添加反饋出錯 |
| 1045 |
無效的 user Key |
| 1047 |
該應用收費，請使用手機進行安裝 |
| 1048 |
應用已過期 |
| 1049 |
應用下載次數已用完 |
| 1050 |
密碼錯誤 |
| 1051 |
應用違規 |
| 1052 |
應用僅認證用戶可以下載 |
| 1053 |
下載速度超過限制 |
| 1054 |
今日下載次數已用完 |
| 1055 |
無效的 api key |
| 1056 |
請在 iOS 系統中打開該鏈接 |
| 1057 |
同步專家測試企業簽名應用參數錯誤 |
| 1058 |
解析應用出錯 |
| 1059 |
廢棄的方法 |
| 1060 |
請輸入你的郵箱 |
| 1061 |
請輸入你的密碼 |
| 1062 |
用戶名或者密碼不正確 |
| 1063 |
該郵箱已存在 |
| 1064 |
請輸入你的用戶名 |
| 1065 |
用戶名不能超過15個字符 |
| 1066 |
請輸入你的姓名 |
| 1067 |
請輸入你的公司 |
| 1068 |
請輸入你的職業 |
| 1069 |
該手機號碼已存在 |
| 1070 |
請輸入驗證碼 |
| 1071 |
驗證碼無效 |
| 1072 |
該郵箱不存在 |
| 1073 |
請輸入正確的賬戶信息 |
| 1075 |
App group key 不能為空 |
| 1076 |
App key 不正確 |
| 1079 |
錄音上傳失敗 |
| 1080 |
反饋失敗 |
| 1081 |
非法請求 |
| 1082 |
Feedback Key 不能為空 |
| 1083 |
反饋信息未找到 |
| 1084 |
日志信息不能為空 |
| 1085 |
系統類型不正確 |
| 1086 |
crash id 不能為空 |
| 1087 |
crash 信息沒有找到 |
| 1089 |
獲取平臺參數不能為空 |
| 1090 |
平臺參數為windows或者mac |
| 1091 |
版本參數不對 |
| 1092 |
版本信息沒有找到 |
| 1093 |
沒有找到信息 |
| 1094 |
app group key 不正確 |
| 1095 |
應用名稱過長 |
| 1096 |
錯誤的方法 |
| 1097 |
簽名錯誤 |
| 1098 |
Api 請求達到每小時的上限 |
| 1099 |
更新 App 失敗 |
| 1100 |
沒有找到 App 分組信息 |
| 1102 |
請輸入郵箱驗證碼 |
| 1103 |
您輸入的驗證碼不正確 |
| 1104 |
您輸入的郵箱地址無效 |
| 1105 |
該賬號已存在 |
| 1106 |
真實姓名的長度必須小于15 |
| 1107 |
請填寫密碼 |
| 1108 |
請正確填寫您的手機號碼 |
| 1109 |
請輸入您的6位驗證碼 |
| 1110 |
注冊失敗 |
| 1111 |
請輸入你的賬號 |
| 1112 |
該手機號碼綁定多個賬號，請使用密碼進行登錄 |
| 1113 |
請填寫郵箱地址 |
| 1115 |
用戶不存在 |
| 1116 |
手機號碼或密碼不正確 |
| 1117 |
郵箱地址或密碼不正確 |
| 1118 |
請輸入手機號碼 |
| 1120 |
每次發送短信的間隔必須在30秒以上 |
| 1121 |
驗證失敗 |
| 1122 |
權限不足 |
| 1123 |
統計類型出錯 |
| 1124 |
授權信息失敗 |
| 1125 |
綁定已有賬號 |
| 1126 |
郵箱未更改 |
| 1127 |
郵箱地址已存在 |
| 1128 |
權限不足，只能刪除自己上傳的應用 |
| 1129 |
該賬號已綁定微信號，請重新輸入賬號 |
| 1130 |
請輸入您的新密碼 |
| 1131 |
請再次輸入密碼 |
| 1132 |
兩次輸入密碼不一致 請重新輸入 |
| 1133 |
JSCode 不能為空 |
| 1134 |
JSCode 無效 |
| 1135 |
沒有找到資質文件 |
| 1136 |
刪除資質文件失敗 |
| 1137 |
上傳資質文件出錯 |
| 1138 |
文件數量超過最大限制 |
| 1139 |
一種類型只能上傳兩張文件 |
| 1140 |
添加資質文件失敗 |
| 1141 |
交易類型不能為空 |
| 1142 |
當前版本不可隱藏 |
| 1143 |
encryptedData和iv不能為空 |
| 1144 |
請輸入安裝開始時間及結束時間 |
| 1145 |
安裝結束時間必須大于開始時間 |
| 1148 |
請上傳身份證正面照片 |
| 1149 |
請上傳身份證反面照片 |
| 1150 |
請上傳手持身份證照片 |
| 1151 |
企業名稱不能為空 |
| 1152 |
營業執照號碼不能為空 |
| 1153 |
請上傳營業執照照片 |
| 1154 |
省份不能為空 |
| 1155 |
城市不能為空 |
| 1156 |
當日自動審核次數已用完 |
| 1157 |
自動審核未通過 |
| 1158 |
圖片不能大于10M |
| 1159 |
圖片不能小于15k |
| 1160 |
圖片類型不正確 |
| 1161 |
fileType 不能為空 |
| 1162 |
名稱不能為空 |
| 1163 |
描述不能為空 |
| 1164 |
appKeys 不能為空 |
| 1165 |
描述文字太長 |
| 1166 |
分組名稱不符合規則 |
| 1167 |
分組的應用，至少兩個 |
| 1168 |
網址后綴不能為空 |
| 1169 |
新號碼和舊號碼不能一樣 |
| 1170 |
手機號碼錯誤 |
| 1171 |
真實姓名不能為空 |
| 1172 |
身份證號不能為空 |
| 1173 |
真實姓名不匹配 |
| 1174 |
身份證號不匹配 |
| 1175 |
發布時間不能為空 |
| 1176 |
請輸入正確的發布時間 |
| 1177 |
獲取應用信息失敗 |
| 1178 |
應用類型不能為空 |
| 1179 |
不能合并空白應用 |
| 1180 |
應用已合并 |
| 1181 |
請合并iOS應用 |
| 1182 |
請合并Android應用 |
| 1183 |
必須是自己的應用 |
| 1184 |
不能和自己合并 |
| 1185 |
圖標已存在不等上傳圖標 |
| 1186 |
應用未發布 |
| 1187 |
請升級您的版本 |
| 1188 |
發生錯誤 |
| 1189 |
暫時不能更改文件 |
| 1190 |
請上傳文網文 |
| 1191 |
請上傳ICP 許可證 |
| 1192 |
上傳軟件著作權登記證 |
| 1193 |
上傳營業熱照 |
| 1194 |
請上傳金融牌照 |
| 1195 |
請上傳其他證件 |
| 1196 |
請上傳有關資質文件 |
| 1197 |
請上傳信息網絡傳播視聽節目許可證 |
| 1198 |
請重新上傳審核不通過的文件 |
| 1199 |
相關文件數目不匹配 |
| 1200 |
申訴理由不能少于20個字符,不能多于500字符 |
| 1201 |
申訴圖片不能大于5張 |
| 1202 |
不能刪除所有可下載版本，如需刪除應用，可在設置中刪除應用 |
| 1203 |
不能刪除所有顯示的版本 |
| 1212 |
渠道短鏈接無效，請檢查短鏈接 |
Tracup 
FrontJS 
企服平臺 
中文
English
