API 2.0

API Description

Our powerful yet useful open API can help you manage your apps, upload builds and get other database of Pgyer. 1. All of API request method are HTTP POST,unless otherwise stated. 2. API of getting resource files like pictures are HTTP POST. 3. The format of API return data is JSON. 4. When you required API, _api_key is necessary. Click here to get api Key Pgyer has introduced API 2.0, recommended for developers to use, API 1.0 version wil l no longer maintain and update.

General Parameter Description/Common Params

Parameters Name Description
_api_key API Key API Key,is used to identify the identity of users who called API. All of API are required this parameter unless otherwise stated. This value is fixed for the same Pgyer's registered users. Click here to get apiKey
userKey User Key userKey, is used to identify the identity of the current user.This value is fixed for the same Pgyer's registered users. Click here to get user key
appKey App Key App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
buildKey Build Key Build Key is the only index ID that identifies the application, which can be obtained by obtaining all versions of the App

Examples

The example of PHP call interface(view apps on APPS):

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'http://www.pgyer.com/apiv2/app/listAll');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'type=ios&_api_key={_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);

Upload App

You can upload your Apps to Pgyer via API. Please use the method HTTP POST when upload. enctype is "multipart/form-data".

API URL

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

Parameters Type Description
_api_key String (Required) API Key Click here to get apiKey
file File (Required) ipa or apk files you need to upload
buildInstallType Integer (Optional)Type of Install, this value is (1,2,3), 1:Public, 2:Password, 3:Restrict. The default is Public
buildPassword String (Optional) Setting App installation password. If you do not want to set a password, please pass on an empty string or do not pass anything.
updateDescription String (Optional) Version updated description, please pass on an empty string or do not pass anything.

Return Data

Parameters Type Description
buildKey String Build Key is the only index ID that identifies the application
buildType Integer Application Type(1:iOS; 2:Android)
buildIsFirst Integer Is it the first App? (1: Yes; 2: No;)
buildIsLastest Integer Is it the newest? (1: Yes; 2: No;)
buildFileSize Integer The size of App
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildDescription String Application Description
buildUpdateDescription String Application Update Description
buildScreenShots String Application screenshots key, the address is http://www.pgyer.com/image/view/app_screenshots/[Application screenshots key]
buildShortcutUrl String App Download Url
buildQRCodeURL String App QR code Url
buildCreated String App Upload time
buildUpdated String App Update time

Upload App Sample

Use the curl command to upload Apps under Linux:

curl -F "file=@/tmp/example.ipa" -F "_api_key={_api_key}" http://www.pgyer.com/apiv2/app/upload

Please replace your _api_key

Install App

This APl can only help you install App on mobile phones,Please use HTTP GET.

API URL

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

GET Parameters

Parameters Type Description
_api_key String (Required) API Key Click here to get apiKey
appKey String (Option, But buildKey and appKey can not be null at the same time) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key), or you can enter the application short link
buildKey String (Option, But buildKey and appKey can not be null at the same time) Build Key is the only index ID that identifies the application, which can be obtained by obtaining all versions of the App
buildPassword String (Option) Please pass on the installation secret when your App need one.

Return Data

Interface automatically use the appropriate installation method to install Apps based on the type of App, iOS or Android.

Examples

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

In-App installations for iOS

The interface of in-app installations for iOS which can help you to install App without opening browser. Interface Address:

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

change {buildKey} to the Key of App.{} is not included.

Examples

Web:

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

iOS:

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

Or:

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

Get App Info

This interface is to get app detailed information.

API URL

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

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey String (Required) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
buildKey String (Option) Build Key is the only index ID that identifies the application, which can be obtained by obtaining all versions of the App

Return Data

Return parameters Type Description
buildKey String Build Key is the only index ID that identifies the application
buildType Integer Application Type(1:iOS; 2:Android)
buildIsFirst Integer Is it the first App? (1:Yes 2: No;)
buildIsLastest Integer Is it the newest? (1:Yes 2: No;)
buildFileSize Integer The size of App
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildDescription String Application Description
buildUpdateDescription String Application Update Description
buildScreenShots String Application screenshots key, the address is http://www.pgyer.com/image/view/app_screenshots/[Application screenshots key]
buildShortcutUrl String App Download Url
buildQRCodeURL String App QR code Url
buildCreated String App Upload time
buildUpdated String App Update time
Historical version return parameters Type Description
buildKey String Build Key is the only index ID that identifies the application
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildCreated String App Upload time
buildUpdated String App Update time

Modify App Group Details (Update All Versions)

API URL

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

Parameters Type Description
_api_key String (Required) API Key Click here to get apiKey
appKey String (Required) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
screenshot file (Option) App screenshots
buildName String (Option) App Name
buildShortcutUrl String (Option) App Download Url
buildUpdateDescription String (Option,When value is null,update is null) Application Update Description
buildDescription String (Option,When value is null,update is null) Application Description
buildPassword String (Option,When value is null,update is null) Setting App Secret
buildInstallType Integer (Optional)Type of Install, this value is (1,2,3), 1:Public, 2:Password, 3:Restrict. The default is Public

Return Data

Return parameter Type Description
buildKey String Build Key is the only index ID that identifies the application
buildType Integer Application Type(1:iOS; 2:Android)
buildIsFirst Integer Is it the first App? (1:Yes 2: No;)
buildIsLastest Integer Is it the newest? (1:Yes 2: No;)
buildFileSize Integer The size of App
buildName String App Name
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildDescription String Application Description
buildUpdateDescription String Application Update Description
buildScreenShots String Application screenshots key, the address is http://www.pgyer.com/image/view/app_screenshots/[Application screenshots key]
buildShortcutUrl String App Download Url
buildQRCodeURL String App QR code Url
buildCreated String App Upload time
buildUpdated String App Update time

Modify App details

API URL

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

Parameters Type Description
_api_key String (Required) API Key Click here to get apiKey
userKey User Key (Required) userKey, is used to identify the identity of the current user.This value is fixed for the same Pgyer's registered users. Click here to get user key
buildKey String (Required) Build Key is the only index ID that identifies the application, which can be obtained by obtaining all versions of the App
screenshot file (Option) App screenshots
buildName String (Option) App Name
buildShortcutUrl String (Option) App Download Url
buildUpdateDescription String (Option,When value is null,update is null) Application Update Description
buildDescription String (Option,When value is null,update is null) Application Description
buildPassword String (Option,When value is null,update is null) Setting App Secret
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
Return parameter Type Description
buildKey String Build Key is the only index ID that identifies the application
buildType Integer Application Type(1:iOS; 2:Android)
buildIsFirst Integer Is it the first App? (1:Yes 2: No;)
buildIsLastest Integer Is it the newest? (1:Yes 2: No;)
buildFileSize Integer The size of App
buildName String App Name
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildDescription String Application Description
buildUpdateDescription String Application Update Description
buildScreenShots String Application screenshots key, the address is http://www.pgyer.com/image/view/app_screenshots/[Application screenshots key]
buildShortcutUrl String App Download Url
buildCreated String App Upload time
buildUpdated String App Update time

Get App All Versions

API URL

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

Parameters Type Description
_api_key String (Required) API Key Click here to get apiKey
appKey String (Option, But buildKey and appKey can not be null at the same time) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
buildKey String (Option, But buildKey and appKey can not be null at the same time) Build Key is the only index ID that identifies the application
page Integer (Option) The pages of Historical version

Return Data

Return parameter Type Description
buildKey String Build Key is the only index ID that identifies the application
buildType Integer Application Type(1:iOS; 2:Android)
buildFileSize Integer The size of App
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildCreated String App Upload time

Get App By Shortcut Url

API URL

POST http://www.pgyer.com/apiv2/app/getByShortcut

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
buildShortcutUrl String (Required) App short cut URL, such as pgyer.com/PgY8 , only need to pass parameters to PgY8.

Return Data

My Apps return parameters Type Description
buildKey String Build Key of the latest Build
buildType Integer Application Type(1:iOS; 2:Android)
buildFileName String File name for uploaded app
buildFileSize Integer The size of App
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildCreated String App Upload time
buildIsFirst Integer Is it the first App? (1:Yes 2: No;)
buildIsLastest Integer Is it the newest? (1:Yes 2: No;)
buildDescription String Application Description
buildUpdateDescription String Application Update Description
buildShortcutUrl String App Download Url
buildScreenShots String Application screenshots key, the address is http://www.pgyer.com/image/view/app_screenshots/[Application screenshots key]

Get My Apps

API URL

POST http://www.pgyer.com/apiv2/app/listMy

Parameters Type Description
_api_key String (Required) API Key Click here to get API Key.
page Integer (Optional) Fill in the digital pages

Return Data

Return parameter Type Description
buildKey String Build Key of the latest Build
buildType Integer Application Type(1:iOS; 2:Android)
buildFileSize Integer The size of App
buildName String App Name
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
buildIdentifier String Application package name, iOS is Bundled , Android is package name.
buildIcon String Icon Key of application, URL is http://www.pgyer.com/image/view/app_icons/[Icon Key of application]
buildCreated String App Upload time

Check App has updates

API URL

POST http://www.pgyer.com/apiv2/app/check

POST Parameters

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey String (Required) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
buildVersion String (Option) The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildBuildVersion Integer (Option) Pgyer's build number is generated for distinguishing historical versions

Return Data

Return parameter Type Description
buildVersion String The default is 1.0 (is the logo that to advertise the application, for example: 1.1, 8.2.1, etc.).
buildVersionNo String The version number of the uploaded package, the default is 1 (that is, the compiled version number, in general, the compiler will change once the version number. For iOS, is a string type; for Android it is an integer. For example: 1001 , 28 etc.)
buildBuildVersion Integer Pgyer's build number is generated for distinguishing historical versions
downloadURL String App install url
buildUpdateDescription String Application Update Description
buildShortcutUrl String App Download Url

List User App Groups

You can set and find your App groups in My APPS - My Groups.

API URL

POST http://www.pgyer.com/apiv2/appGroup/listAll

Parameters Type Description
_api_key String (Required) API Key Click here to get api key

Return Data

Return parameter Type Description
appGroupName String App Group name
appGroupKey String App Group key (Uniquely)
appGroupShortcutURL String the short cut URL of App Group
appGroupDescription String the description of App Group
appGroupCount String the amount of App Group
appCreated String the creation time of App Group

View User App Groups

You can set and find your App groups in My APPS - My Groups.This interface returns the details of a App group and also returns the information of this group (Only for the latest version).

API URL

POST http://www.pgyer.com/apiv2/appGroup/view

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appGroupKey String (Required) The key of App group. You can get it via appGroup/listAll interface.

Return Data

Return parameter Type Description
appGroupName String App Group name
appGroupKey String App Group key (Uniquely)
appGroupShortcutURL String the short cut URL of App Group
appGroupDescription String the description of App Group
appGroupCount String the amount of App Group
appCreated String the creation time of App Group
apps Array Apps included in the App Group

View App Feedback List

API URL

POST http://www.pgyer.com/apiv2/feedback/listAll

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey String (Required) App Key is a unique Key for An App group. For example, If an App named “Wechat” uploaded three versions and they were belong to an App group, App ID represents the group Key.(Values shown in Application Details - Application Overview - App Key)
page Integer (Option) Fill in the digital pages

Return Data

Return parameter Type Description
feedBackContent String Feedback content
feedBackImages Array Feedback information in the picture address
feedBackVoice String Recording file address
feedBackFrom String Feedback source
feedbackProcess Integer Feedback processing status (1: processed; 2: untreated)
feedBackCreated String Feedback creation time

View App feedback details

API URL

POST http://www.pgyer.com/apiv2/feedback/view

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey String (Required) represents the only Key of an App group. For example, the name "weChat" App uploaded three versions, then the three versions of an App group, the parameters that the Group's Key. This value can be seen in the application management background.
feedbackKey String (Required) The key of the feedback message can be obtained via the feedbackListAll interface

Return Data

Return parameter Type Description
feedBackContent String Feedback content
feedBackImages Array Feedback information in the picture address
feedBackVoice String Recording file address
feedBackDeviceName String Device name
feedBackOSVersion String Phone system version
feedBackOSType Integer Phone system type(1:iOS; 2:Android)
feedBackOSJailBroken Integer Whether the phone jailbreak or ROOT (1: yes;2: no)
feedBackFreeRam String The remaining memory size of the phone
feedBackFreeSpace String The size of the remaining disk space on the phone
feedBackNetwork String Mobile phone network
feedBackSDKVersion String SDK Version
feedBackFrom String Feedback source
feedbackProcess Integer Feedback processing status (1: processed; 2: untreated)
buildType Integer Application Type (1:iOS; 2:Android)
buildName String App Name
feedBackCreated String Feedback creation time

View application Crash log list

API URL

POST http://www.pgyer.com/apiv2/crash/listAll

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey App Key (Required) represents the only Key of an App group. For example, the name "weChat" App uploaded three versions, then the three versions of an App group, the parameters that the Group's Key.(Values shown in Application Details - Application Overview - App Key)
page Integer (Option) Fill in the digital pages

Return Data

Return parameter Type Description
crashCount Integer Crash Count
crashTitle String Crash Title
crashPattern String Crash Pattern
crashDescribe String Crash Description
crashAppVersion String Crash App Version
crashProcess String Crash Processing state
crashId Integer CrashGroupId
crashCreated String Crash Create time

View application Crash log detail

API URL

POST http://www.pgyer.com/apiv2/crash/view

Parameters Type Description
_api_key String (Required) API Key Click here to get api key
appKey App Key (Required) represents the only Key of an App group. For example, the name "weChat" App uploaded three versions, then the three versions of an App group, the parameters that the Group's Key .(Values shown in Application Details - Application Overview - App Key)
crashId Integer (Required) sdkCrashGroupId, You can get some crash sdkCrashGroupId through the crashListAll interface

Return Data

Return parameter Type Description
scrashLog String Crash Log
scrashCount Integer Crash Count
scrashTitle String Crash Title
scrashPattern String Crash Pattern
scrashDescribe String Crash Description
scrashAppVersion String Crash App Version
scrashIsSymbolicated String Crash Log Is symbolized
scrashIsReaded String Crash Have read
scrashProcess String Crash Processing state
scrashViewStatus String Crash View status
deviceAffectList Array Affect the equipment situation
crashCreated String Crash Create time

Error code meaning

ErrorCode Description
1001 _api_key can not be empty
1002 _api_key not found
1003 Synchronize user information to Tracup error message
1007 app search keyword is too short
1008 Build Key and appKey can not be empty at the same time
1009 App not found
1010 App Key can not be empty
1011 App Id empty
1012 User key can not be empty
1013 User can not be found
1014 Type can not be empty
1015 Invalid type
1016 Invalid packagename
1017 The shortcut URL is occupied or does not comply with the rules
1018 App remaining runs out.
1019 developers must be certified by the real name before they can publish App on the PGYER
1020 Uploading has been disabled due to a violation of PGYER\'s Terms and Conditions
1021 Data of file can not be empty
1022 Files size too large.
1023 build key can not be empty
1024 Incorrect publish range'
1025 File upload failed
1026 Invalid file, file type incorrect
1027 App name does not match the rule'
1028 The Bundle Identifier can not be found.
1029 App shortcut URL is used
1030 The number of business signatures issued exceeds the maximum value of the package
1031 The shortcut URL can not be empty
1032 The shortcut URL is invalid
1033 You are only allowed to modify your uploaded app'
1035 Update field exceeds limit
1036 The update content must not be empty
1037 Please upload the image as an array'
1038 Image data is empty'
1039 App screenshot can upload more than 5
1040 Screenshots failed to upload'
1041 iKey not found'
1042 Content can not be empty
1043 The content length of feedback can not more than 2000 words.
1044 Add comment error
1045 Invalid UserID
1047 The app is fee download, please use the phone to install.
1048 The app has been expired
1049 App download remaning runs out.
1050 Password is incorrect
1051 App is blocked
1052 The app provider is not authenticated and you can not download the app.
1053 Sorry, download is too fast, please try again later.
1054 Sorry, Today\'s download has been used, please try again tomorrow.
1055 Invalid api key
1056 Please open this link on iOS System.
1057 signature App Publish To Pgyer param error
1058 Decode app info error')
1059 The deprecated method!
1060 Please enter your email
1061 Please enter your password
1062 Username or password is incorrect
1063 E-mail address already exists, please change the email address
1064 Please enter your username
1065 The length of the user name must be less than 15
1066 Please enter your phone number
1067 Please enter your company
1068 Please enter your position
1069 Phone number already exists, please change phone number
1070 code is required.
1071 code is expired.
1072 The email address does not exist
1073 Please enter the correct information
1075 App group key can not be empty
1076 App key is not correct
1079 voice upload failed
1080 feedback error
1081 error request
1082 Feedback Key can not empty
1083 Feedback info can not found
1084 Log can not be empty
1085 OS type is not correct
1086 crash id can not be empty
1087 crash info not found
1088 Log can not be empty
1089 Get platform parameters can not be empty
1090 platform parameters is windows or mac
1091 Version parameter is incorrect
1092 Version Information Not Found
1093 No information found
1094 app group key not found
1095 app name too long
1096 Unknown method
1097 signature error
1098 Api request has reached the upper limit per hour
1099 Update App failed
1100 Not found app group info