API 1.0 (Archive)
App Information
Legacy API 1.0 endpoints for viewing and updating app information.
This page documents legacy API 1.0 endpoints. New integrations should use API 2.0 App Information.
View App Details
POST
https://api.pgyer.com/apiv1/app/viewRequest Parameters
| Parameter | Type | Description |
|---|---|---|
| aKey | String | App Key. |
| uKey | String | Optional. User Key. |
| _api_key | String | API Key. |
Response Data
App details:
| Parameter | Type | Description |
|---|---|---|
| appKey | String | App Key. |
| userKey | String | User Key. |
| appType | Integer | App type: 1 iOS, 2 Android. |
| appIsFirst | Integer | Whether this is the first build: 1 yes, 2 no. |
| appIsLastest | Integer | Whether this is the latest build: 1 yes, 2 no. |
| appFileSize | Integer | App file size. |
| appName | String | App name. |
| appVersion | String | Version. |
| appVersionNo | Integer | Android version code; always 0 for iOS. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appIdentifier | String | Bundle ID on iOS or package name on Android. |
| appIcon | String | App icon key. Retrieve the image from https://www.pgyer.com/image/view/app_icons/{appIcon}. |
| appDescription | String | App description. |
| appUpdateDescription | String | Release notes. |
| appScreenShots | String | Screenshot keys. Retrieve an image from https://www.pgyer.com/image/view/app_screenshots/{screenshotKey}. |
| appShortcutUrl | String | App short URL. |
| appQRCodeURL | String | App QR-code URL. |
| appCreated | String | Upload time. |
| appUpdated | String | Last update time. |
Historical builds:
| Parameter | Type | Description |
|---|---|---|
| appKey | String | App Key. |
| userKey | String | User Key. |
| appName | String | App name. |
| appVersion | String | Version. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appCreated | String | Upload time. |
| appUpdated | String | Last update time. |
App feedback:
| Parameter | Type | Description |
|---|---|---|
| userKey | String | User Key. |
| commentContent | String | Feedback content. |
| commentImageKeys | String | Feedback screenshot keys. Retrieve an image from https://www.pgyer.com/image/view/comment_screenshot/{imageKey}. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appIdentifier | String | Bundle ID on iOS or package name on Android. |
| appCreated | String | Upload time. |
| appUpdated | String | Last update time. |
Update App Details
POST
https://api.pgyer.com/apiv1/app/updateRequest Parameters
| Parameter | Type | Description |
|---|---|---|
| aKey | String | App Key. |
| uKey | String | User Key. |
| _api_key | String | API Key. |
| appName | String | Optional. App name. |
| appShortcutUrl | String | Optional. App shortcut URL. |
| appUpdateDescription | String | Optional. Update description. Empty value clears the field. |
| appDescription | String | Optional. App description. Empty value clears the field. |
| appPassword | String | Optional. App password. Empty value clears the field. |
| appVersion | String | Optional. App version. |
| appScreenshots | String | Optional. Screenshot keys. Empty value clears the field. |
Response Data
| Parameter | Type | Description |
|---|---|---|
| appKey | String | App Key. |
| userKey | String | User Key. |
| appType | Integer | App type: 1 iOS, 2 Android. |
| appIsFirst | Integer | Whether this is the first build: 1 yes, 2 no. |
| appIsLastest | Integer | Whether this is the latest build: 1 yes, 2 no. |
| appFileSize | Integer | App file size. |
| appName | String | App name. |
| appVersion | String | Version. |
| appVersionNo | Integer | Android version code; always 0 for iOS. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appIdentifier | String | Bundle ID on iOS or package name on Android. |
| appIcon | String | App icon key. Retrieve the image from https://www.pgyer.com/image/view/app_icons/{appIcon}. |
| appDescription | String | App description. |
| appUpdateDescription | String | Release notes. |
| appScreenShots | String | Screenshot keys. Retrieve an image from https://www.pgyer.com/image/view/app_screenshots/{screenshotKey}. |
| appShortcutUrl | String | App short URL. |
| appQRCodeURL | String | App QR-code URL. |
| appCreated | String | Upload time. |
| appUpdated | String | Last update time. |
Get App Info by Shortcut
POST
https://api.pgyer.com/apiv1/app/getAppKeyByShortcutRequest Parameters
| Parameter | Type | Description |
|---|---|---|
| shortcut | String | App shortcut, for example PgY8 from pgyer.com/PgY8. |
| _api_key | String | API Key. |
Response Data
| Parameter | Type | Description |
|---|---|---|
| appKey | String | App Key of the latest build. |
| appType | Integer | App type: 1 iOS, 2 Android. |
| appFileName | String | Uploaded file name. |
| appFileSize | Integer | App file size. |
| appName | String | App name. |
| appVersion | String | Version. |
| appVersionNo | Integer | Android version code; always 0 for iOS. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appIdentifier | String | Bundle ID on iOS or package name on Android. |
| appCreated | String | Upload time. |
List My Published Apps
POST
https://api.pgyer.com/apiv1/user/listMyPublishedRequest Parameters
| Parameter | Type | Description |
|---|---|---|
| uKey | String | User Key. |
| page | Integer | Optional page number. |
| _api_key | String | API Key. |
Response Data
| Parameter | Type | Description |
|---|---|---|
| appKey | String | App Key of the latest build. |
| appType | Integer | App type: 1 iOS, 2 Android. |
| appFileSize | Integer | App file size. |
| appName | String | App name. |
| appVersion | String | Version. |
| appVersionNo | Integer | Android version code; always 0 for iOS. |
| appBuildVersion | Integer | Build number generated by Pgyer to distinguish historical builds. |
| appIdentifier | String | Bundle ID on iOS or package name on Android. |
| appIcon | String | App icon key. Retrieve the image from https://www.pgyer.com/image/view/app_icons/{appIcon}. |
| appCreated | String | Upload time. |