API 1.0

API Description

Our powerful yet useful open API can help you manage your apps, upload builds and get other database of Pgyer.

All of API request method are HTTP POST，unless otherwise stated.
API of getting resource files like pictures are HTTP POST.
The format of API return data is JSON.
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 will 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 API Key.
uKey	User Key	uKey, 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 uKey
aId	App Id	App ID is a unique ID 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 ID.You can find App ID in MY APPS.
aKey	App Key	App key represents an App unique indentification. For example, if an App named “Wechat” uploaded three versions, every of versions has a different aKey and this value is returned via other interface.

Examples

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

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'http://www.xcxwo.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=Please log in, you can view it after a successful login&page=1');
$response = curl_exec($curl);
if (curl_errno($curl)) {
    echo curl_error($curl);
}
curl_close($curl);
$jsonData = json_decode($response, true);
// output $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://upload.xcxwo.com/apiv1/app/upload

Parameters	Type	Description
uKey	String	(Required) uKey Click here to get uKey
_api_key	String	(Required) API Key Click here to get API Key.
file	File	(Required) ipa or apk files you need to upload
installType	Integer	(Optional)Type of Install, this value is (1,2,3), 1:Public, 2:Password, 3:Restrict. The default is Public
password	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.
channelShortcut	String	(Optional)The short link to download for the specified channel you want to update, you can only specify one channel, string type, such as: abcd.

Return Data

Parameters	Type	Description
appKey	String	App Key
userKey	String	User Key
appType	Integer	Application Type（1:iOS; 2:Android）
appIsFirst	Integer	Is it the first App? (1. Yes; 2: No;)
appIsLastest	Integer	Is it the newest? (1. Yes; 2. No;)
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appDescription	String	Application Description
appUpdateDescription	String	Application Update Description
appScreenShots	String	Application screenshots key, the address is https://www.xcxwo.com/image/view/app_screenshots/[Application screenshots key]
appShortcutUrl	String	App Download Url
appQRCodeURL	String	App QR code Url
appCreated	String	App Upload time
appUpdated	String	App Update time

Upload App Sample

Use the curl command to upload Apps under Linux:

curl -F "file=@/tmp/example.ipa" -F "uKey=Please log in, you can view it after a successful login" -F "_api_key=Please log in, you can view it after a successful login" http://upload.xcxwo.com/apiv1/app/upload

Please replace your uKey and _api_key

Install App

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

API URL

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

GET Parameters

Parameters	Description
aKey	App Key (App Key is an index that uniquely identities the application ID.You can get it through a short link interfaces or my application interface.)
_api_key	API Key Click here to get API Key.
password	(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.xcxwo.com/apiv1/app/install?_api_key=Please log in, you can view it after a successful login&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456

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.xcxwo.com/app/plist/{aKey}

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

Examples

Web:

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

iOS:

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

Or:

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.xcxwo.com/apiv1/app/install?_api_key=Please log in, you can view it after a successful login&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456"]];

Get App Info

This interface is to get app detailed information.

API URL

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

Parameters	Type	Description
aKey	String	(App Key is an index that uniquely identities the application ID.You can get it through a short link interfaces or my application interface.)
uKey	String	(Option) uKey Click here to get uKey
_api_key	String	API Key Click here to get API Key.

Return Data

My Apps return parameters	Type	Description
appKey	String	App Key
userKey	String	User Key
appType	Integer	Application Type（1:iOS; 2:Android）
appIsFirst	Integer	Is it the first App? (1. Yes; 2: No;)
appIsLastest	Integer	Is it the newest? (1. Yes; 2. No;)
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appDescription	String	Application Description
appUpdateDescription	String	Application Update Description
appScreenShots	String	Application screenshots key, the address is https://www.xcxwo.com/image/view/app_screenshots/[Application screenshots key]
appShortcutUrl	String	App Download Url
appQRCodeURL	String	App QR code Url
appCreated	String	App Upload time
appUpdated	String	App Update time

Historical version return parameters	Type	Description
appKey	String	App Key
userKey	String	User Key
appName	String	App Name
appVersion	String	Version Code
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appCreated	String	App Upload time
appUpdated	String	App Update time

Feedback return parameters	Type	Description
userKey	Integer	User Key
commentContent	Integer	Feedback
commentImageKeys	Integer	Application screenshots key, the address is https://www.xcxwo.com/image/view/comment_screenshot/[Application screenshots key]
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	Integer	Application package name, iOS is Bundled , Android is package name.
appCreated	Integer	App Upload time
appUpdated	Integer	App Update time

Get App Group Info

When App have different versions, we combine versions to a App Group. Every App Group has their unique App ID. The interface can get App group detailed information.

API URL

POST http://www.xcxwo.com/apiv1/app/viewGroup

Parameters	Type	Description
aId	String	App Id
_api_key	String	API Key Click here to get API Key.

Return Data

My Apps return parameters	Type	Description
appKey	String	App Key
appType	Integer	Application Type（1:iOS; 2:Android）
appIsFirst	Integer	Is it the first App? (1. Yes; 2: No;)
appIsLastest	Integer	Is it the newest? (1. Yes; 2. No;)
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appDescription	String	Application Description
appUpdateDescription	String	Application Update Description
appScreenShots	String	Application screenshots key, the address is https://www.xcxwo.com/image/view/app_screenshots/[Application screenshots key]
appShortcutUrl	String	App Download Url
appQRCodeURL	String	App QR code Url
appCreated	String	App Upload time
appUpdated	String	App Update time

Edit App Details

API URL

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

Parameters	Type	Description
aKey	String	App Key (App Key is an index that uniquely identities the application ID.You can get it through a short link interfaces or my application interface.)
uKey	String	uKey Click here to get uKey
_api_key	String	API Key Click here to get API Key.
appName	String	(Option) App Name
appShortcutUrl	String	(Option) App Download Url
appUpdateDescription	String	(Option,When value is null,update is null) Application Update Description
appDescription	String	(Option,When value is null,update is null) Application Description
appPassword	String	(Option,When value is null,update is null) Setting App Secret
appVersion	String	(Option) Version Code
appScreenshots	String	(Option,When value is null,update is null) Application screenshots key

Return Data

Return parameter	Type	Description
appKey	String	App Key
userKey	String	User Key
appType	Integer	Application Type（1:iOS; 2:Android）
appIsFirst	Integer	Is it the first App? (1. Yes; 2: No;)
appIsLastest	Integer	Is it the newest? (1. Yes; 2. No;)
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appDescription	String	Application Description
appUpdateDescription	String	Application Update Description
appScreenShots	String	Application screenshots key, the address is https://www.xcxwo.com/image/view/app_screenshots/[Application screenshots key]
appShortcutUrl	String	App Download Url
appQRCodeURL	String	App QR code Url
appCreated	String	App Upload time
appUpdated	String	App Update time

Get App All Versions

API URL

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

Parameters	Type	Description
aId	String	App Id
page	Integer	The pages of Historical version
_api_key	String	API Key Click here to get API Key.

Return Data

Return parameter	Type	Description
appKey	String	App Key of the latest Build
appType	Integer	Application Type（1:iOS; 2:Android）
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appCreated	String	App Upload time

Upload App Screenshot

API URL

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

Parameters	Type	Description
aKey	String	App Key (App Key is an index that uniquely identities the application ID.You can get it through a short link interfaces or my application interface.)
_api_key	String	API Key Click here to get API Key.
image	File	Need to upload screenshots, you can upload maximum 5

Return Data

Return parameter	Type	Description
keys	String	After App upload screenshots key (comma separated) to obtain address https://www.xcxwo.com/image/view/app_screenshots/[Application screenshots key]

Get App Info By Shortcut

API URL

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

Parameters	Type	Description
shortcut	String	App short cut URL, such as pgyer.com/PgY8 , only need to pass parameters to PgY8.
_api_key	String	API Key Click here to get API Key.

Return Data

My Apps return parameters	Type	Description
appKey	String	App Key of the latest Build
appType	Integer	Application Type（1:iOS; 2:Android）
appFileName	String	File name for uploaded app
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appCreated	String	App Upload time

Get My Apps

API URL

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

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

Return Data

Return parameter	Type	Description
appKey	String	App Key of the latest Build
appType	Integer	Application Type（1:iOS; 2:Android）
appFileSize	Integer	The size of App
appName	String	App Name
appVersion	String	Version Code
appVersionNo	Integer	Version Code for Android, iOS is always 0
appBuildVersion	Integer	Pgyer's build number is generated for distinguishing historical versions
appIdentifier	String	Application package name, iOS is Bundled , Android is package name.
appIcon	String	Icon Key of application, URL is https://www.xcxwo.com/image/view/app_icons/[Icon Key of application]
appCreated	String	App Upload time

List User App Groups

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

API URL

POST http://www.xcxwo.com/apiv1/userAppGroup/listAll

Parameters	Type	Description
uKey	String	uKey Click here to get uKey
_api_key	String	API Key Click here to get API Key.

Return Data

Return parameter	Type	Description
userAppGroupName	String	App Group name
userAppGroupKey	String	App Group key (Uniquely)
userAppGroupShortcutURL	String	the short cut URL of App Group
userAppGroupDescription	String	the description of App Group
userAppGroupCount	String	the amount of App Group
userAppCreated	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.xcxwo.com/apiv1/userAppGroup/view

Parameters	Type	Description
userAppGroupKey	String	The key of App group. You can get it via userAppGroup/view interface.
_api_key	String	API Key Click here to get API Key.

Return Data

Return parameter	Type	Description
userAppGroupName	String	App Group name
userAppGroupKey	String	App Group key (Uniquely)
userAppGroupShortcutURL	String	the short cut URL of App Group
userAppGroupDescription	String	the description of App Group
userAppGroupCount	String	the amount of App Group
userAppCreated	String	the creation time of App Group
apps	Array	Apps included in the App Group

View App Feedback List

API URL

POST http://www.xcxwo.com/apiv1/feedback/listAll

Parameters	Type	Description
aId	String	App Id
_api_key	String	API Key Click here to get API Key.
page	Integer	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.xcxwo.com/apiv1/feedback/view

Parameters	Type	Description
aId	String	App Id
feedbackKey	String	The key of the feedback message can be obtained via the feedbackListAll interface
_api_key	String	API Key Click here to get API Key.

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)
appType	Integer	Application Type （1:iOS; 2:Android）
appName	String	App Name
feedBackCreated	String	Feedback creation time

View application Crash log list

API URL

POST http://www.xcxwo.com/apiv1/crash/listAll

Parameters	Type	Description
aId	String	App Id
_api_key	String	API Key Click here to get API Key.
page	Integer	Fill in the digital pages

Return Data

Return parameter	Type	Description
sdkCrashGroupCount	Integer	Crash Count
sdkCrashGroupTitle	String	Crash Title
sdkCrashGroupPattern	String	Crash Pattern
sdkCrashGroupDescribe	String	Crash Description
sdkCrashGroupAppVersion	String	Crash App Version
sdkCrashGroupProcess	String	Crash Processing state
sdkCrashGroupId	Integer	CrashGroupId
sdkCrashGroupCreated	String	Crash Create time

View application Crash log detail

API URL

POST http://www.xcxwo.com/apiv1/crash/view

Parameters	Type	Description
aId	String	App Id
sdkCrashGroupId	Integer	sdkCrashGroupId, You can get some crash sdkCrashGroupId through the crashListAll interface
_api_key	String	API Key Click here to get API Key.

Return Data

Return parameter	Type	Description
sdkCrashGroupLog	String	Crash Log
sdkCrashGroupCount	Integer	Crash Count
sdkCrashGroupTitle	String	Crash Title
sdkCrashGroupPattern	String	Crash Pattern
sdkCrashGroupDescribe	String	Crash Description
sdkCrashGroupAppVersion	String	Crash App Version
sdkCrashGroupIsSymbolicated	String	Crash Log Is symbolized
sdkCrashGroupIsReaded	String	Crash Have read
sdkCrashGroupProcess	String	Crash Processing state
sdkCrashGroupViewStatus	String	Crash View status
deviceAffectList	Array	Affect the equipment situation
sdkCrashGroupCreated	String	Crash Create time