API 1.0

Описание интерфейса

С использованием предоставленного интерфейса PGYER сторонние разработчики могут загружать, хостить, устанавливать и т. д. приложения, предоставленные PGYER, в свое собственное приложение, а также могут получать различные данные приложений, предоставленных PGYER, с помощью данных интерфейсов, чтобы облегчить разработчикам распространение приложений для внутреннего тестирования.

За исключением особых указаний, все запросы к API данных осуществляются с использованием метода HTTP POST.
Запросы к интерфейсу получения изображений и других ресурсов выполняются с использованием метода HTTP GET.
Формат данных, возвращаемых интерфейсом API, - JSON.
При выполнении всех запросов к интерфейсу необходимо включать параметр _api_key для идентификации идентичности интерфейса. Нажмите, чтобы получить _api_key

PGYER теперь представил API 2.0, рекомендуется использовать разработчикам, версия API 1.0 больше не поддерживается и не обновляется.

Общее описание параметров

Параметр	Эпитет	Описание
_api_key	API Key	API ключ, используемый для идентификации вызывающего API лица. Если не указано иное, этот параметр должен присутствовать в каждом интерфейсе. Для зарегистрированного пользователя PGYER это значение является постоянным.Нажмите, чтобы получить _api_key
uKey	User Key	Ключ пользователя, используемый для идентификации текущего пользователя. Для зарегистрированного пользователя PGYER это значение является постоянным. Нажмите, чтобы получить_ukey
aId	App Id	Уникальный идентификатор группы приложений. Например, если приложение с именем "WeChat" загрузило три версии, то эти три версии образуют группу приложений, и этот параметр представляет идентификатор этой группы. Это значение можно увидеть в административной панели управления приложениями.
aKey	App Key	Уникальный идентификатор конкретного приложения. Например, если приложение с именем "WeChat" загрузило три версии, то у каждой версии будет свой aKey, который обычно возвращается через другие интерфейсы.

Пример кода

Пример вызова API на PHP (просмотр приложения на площадке):

$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=Пожалуйста, войдите, чтобы просмотреть&page=1');
$response = curl_exec($curl);
if (curl_errno($curl)) {
    echo curl_error($curl);
}
curl_close($curl);
$jsonData = json_decode($response, true);
// output $jsonData ...

Загрузить приложение

С помощью этого API разработчики могут непосредственно загружать приложение на PGYER. При загрузке используйте метод HTTP POST с enctype "multipart/form-data"

URL API

POST http://upload.xcxwo.com/apiv1/app/upload

Параметры POST

Параметр	Тип	Описание
uKey	String	(Обязательно) Ключ пользователя Нажмите, чтобы получить_ukey
_api_key	String	(обязательно) API ключ Нажмите, чтобы получить _api_key
file	File	(обязательно) Файл ipa или apk для загрузки
installType	Integer	(Необязательно) Способ установки приложения, значение (1,2,3). 1: Публичный, 2: Установка по паролю, 3: Пригласительная установка. По умолчанию 1 - публичный
password	String	(необязательно) Установить пароль для установки приложения, если не хотите устанавливать пароль, передайте пустую строку или не передавайте его.
updateDescription	String	(необязательно) Описание обновления версии, передайте пустую строку или не передавайте его.
channelShortcut	String	(необязательно) Ссылка для скачивания для указанного канала обновлений, можно указать только один канал, строковый тип, например: abcd.

Возвращаемые данные

Параметр	Тип	Описание
appKey	String	App Key
userKey	String	User Key
appType	Integer	Тип приложения（1:iOS; 2:Android）
appIsFirst	Integer	Является ли первым приложением (1: да; 2: нет)
appIsLastest	Integer	Является ли последней версией (1: да; 2: нет)
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appDescription	String	Описание приложения
appUpdateDescription	String	Инструкции по обновлению приложения
appScreenShots	String	Ключ скриншота приложения, адрес доступа: https://www.xcxwo.com/image/view/app_screenshots/[Ключ скриншота приложения]
appShortcutUrl	String	Короткая ссылка на приложение
appQRCodeURL	String	Адрес QR-кода приложения
appCreated	String	Время загрузки приложения
appUpdated	String	Время обновления приложения

Пример загрузки приложения

Пример загрузки приложения с использованием команды crul в Linux:

curl -F "file=@/tmp/example.ipa" -F "uKey=Пожалуйста, войдите, чтобы просмотреть" -F "_api_key=Пожалуйста, войдите, чтобы просмотреть" http://upload.xcxwo.com/apiv1/app/upload

Пожалуйста, замените значения uKey и _api_key на соответствующие значения вашего аккаунта разработчика.

Установить приложение

Через этот интерфейс можно непосредственно установить приложение на телефон, пожалуйста, используйте метод HTTP GET. Этот интерфейс доступен только на мобильных устройствах, просто запросите этот адрес через мобильный браузер, чтобы начать установку.

URL API

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

Параметры GET

Параметр	Описание
aKey	App Key (App Key - это уникальный индекс идентификации приложения, который можно получить через интерфейс коротких ссылок или мой интерфейс приложений)
_api_key	API Key Нажмите, чтобы получить _api_key
password	(необязательно) Если для установки приложения требуется пароль, передайте пароль установки приложения

Возвращаемые данные

Интерфейс автоматически выберет метод установки приложения в зависимости от его типа (iOS или Android).

Пример кода

http://www.xcxwo.com/apiv1/app/install?_api_key=Пожалуйста, войдите, чтобы просмотреть&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456

Установка в приложении для iOS

Интерфейс установки в приложении для iOS, который позволяет пользователям устанавливать приложение без необходимости открывать браузер. Адрес интерфейса:

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

Пожалуйста, замените {aKey} на ключ приложения, без фигурных скобок.

Пример кода

Web:

<a href="itms-services://?action=download-manifest&url=https://www.xcxwo.com/app/plist/f3c7897cf8ac70a3d345699ef6e1584d>Установить</a>

iOS:

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

Или:

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.xcxwo.com/apiv1/app/install?_api_key=Пожалуйста, войдите, чтобы просмотреть&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456"]];

Получить подробную информацию о приложении

Этот интерфейс позволяет получить подробную информацию о конкретной версии приложения.

URL API

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

Параметры POST

Параметр	Тип	Описание
aKey	String	(App Key - это уникальный индекс идентификации приложения, который можно получить через интерфейс коротких ссылок или мой интерфейс приложений)
uKey	String	(Необязательно) Ключ пользователяНажмите, чтобы получить_ukey
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Параметры возврата информации о приложении	Тип	Описание
appKey	String	App Key
userKey	String	User Key
appType	Integer	Тип приложения（1:iOS; 2:Android）
appIsFirst	Integer	Является ли первым приложением (1: да; 2: нет)
appIsLastest	Integer	Является ли последней версией (1: да; 2: нет)
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appDescription	String	Описание приложения
appUpdateDescription	String	Инструкции по обновлению приложения
appScreenShots	String	Ключ скриншота приложения, адрес доступа: https://www.xcxwo.com/image/view/app_screenshots/[Ключ скриншота приложения]
appShortcutUrl	String	Короткая ссылка на приложение
appQRCodeURL	String	Адрес QR-кода приложения
appCreated	String	Время загрузки приложения
appUpdated	String	Время обновления приложения

Параметры возврата информации о предыдущих версиях	Тип	Описание
appKey	String	App Key
userKey	String	User Key
appName	String	Название приложения
appVersion	String	Номер версии
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appCreated	String	Время загрузки приложения
appUpdated	String	Время обновления приложения

Параметры возврата обратной связи приложения	Тип	Описание
userKey	Integer	User Key
commentContent	Integer	Содержание обратной связи
commentImageKeys	Integer	Ключ скриншота обратной связи, адрес доступа:https://www.xcxwo.com/image/view/comment_screenshot/[Ключ скриншота обратной связи]
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	Integer	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appCreated	Integer	Время загрузки приложения
appUpdated	Integer	Время обновления приложения

Получить подробную информацию о группе приложений

PGYER объединяет разные версии одного и того же приложения в одну группу, которую мы называем "группой приложений". Для каждой "группы приложений" существует уникальный идентификатор приложения. Этот интерфейс используется для получения подробной информации о группе приложений.

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Параметры возврата информации о приложении	Тип	Описание
appKey	String	App Key
appType	Integer	Тип приложения（1:iOS; 2:Android）
appIsFirst	Integer	Является ли первым приложением (1: да; 2: нет)
appIsLastest	Integer	Является ли последней версией (1: да; 2: нет)
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appDescription	String	Описание приложения
appUpdateDescription	String	Инструкции по обновлению приложения
appScreenShots	String	Ключ скриншота приложения, адрес доступа: https://www.xcxwo.com/image/view/app_screenshots/[Ключ скриншота приложения]
appShortcutUrl	String	Короткая ссылка на приложение
appQRCodeURL	String	Адрес QR-кода приложения
appCreated	String	Время загрузки приложения
appUpdated	String	Время обновления приложения

Изменить подробную информацию о приложении

URL API

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

Параметры POST

Параметр	Тип	Описание
aKey	String	App Key (App Key - это уникальный индекс идентификации приложения, который можно получить через интерфейс коротких ссылок или мой интерфейс приложений)
uKey	String	Ключ пользователяНажмите, чтобы получить_ukey
_api_key	String	API Key Нажмите, чтобы получить _api_key
appName	String	(Необязательно) Название приложения
appShortcutUrl	String	(Необязательно) URL-адрес короткой ссылки на приложение
appUpdateDescription	String	(Необязательно, если значение пустое, обновить как пустое) Описание обновления приложения
appDescription	String	(Необязательно, если значение пустое, обновить как пустое) Описание приложения
appPassword	String	(Необязательно, если значение пустое, обновить как пустое) Установить пароль приложения
appVersion	String	(Необязательно) Информация о версии приложения
appScreenshots	String	(Необязательно, если пусто, обновите пусто) Ключ скриншота приложения

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
appKey	String	App Key
userKey	String	User Key
appType	Integer	Тип приложения（1:iOS; 2:Android）
appIsFirst	Integer	Является ли первым приложением (1: да; 2: нет)
appIsLastest	Integer	Является ли последней версией (1: да; 2: нет)
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appDescription	String	Описание приложения
appUpdateDescription	String	Инструкции по обновлению приложения
appScreenShots	String	Ключ скриншота приложения, адрес доступа: https://www.xcxwo.com/image/view/app_screenshots/[Ключ скриншота приложения]
appShortcutUrl	String	Короткая ссылка на приложение
appQRCodeURL	String	Адрес QR-кода приложения
appCreated	String	Время загрузки приложения
appUpdated	String	Время обновления приложения

Получить все версии приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
page	Integer	Номер страницы истории версий
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
appKey	String	Возвращает ключ приложения для последней сборки
appType	Integer	Тип приложения（1:iOS; 2:Android）
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appCreated	String	Время загрузки приложения

Загрузить скриншот приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aKey	String	App Key (App Key - это уникальный индекс идентификации приложения, который можно получить через интерфейс коротких ссылок или мой интерфейс приложений)
_api_key	String	API Key Нажмите, чтобы получить _api_key
image	File	Необходимо загрузить скриншоты, можно загрузить до 5 штук

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
keys	String	Все ключи скриншотов приложения после загрузки (разделены запятыми), адрес для получения https://www.xcxwo.com/image/view/app_screenshots/[Ключ скриншота приложения]

Получить информацию о приложении с помощью короткой ссылки

URL API

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

Параметры POST

Параметр	Тип	Описание
shortcut	String	Короткая ссылка на приложение, например pgyer.com/PgY8, достаточно передать параметр PgY8
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Параметры возврата информации о приложении	Тип	Описание
appKey	String	Возвращает ключ приложения для последней сборки
appType	Integer	Тип приложения（1:iOS; 2:Android）
appFileName	String	Имя загруженного приложения
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appCreated	String	Время загрузки приложения

Просмотреть загруженные мной приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
uKey	String	Ключ пользователяНажмите, чтобы получить_ukey
page	Integer	(Необязательно) Укажите номер страницы
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
appKey	String	Возвращает ключ приложения для последней сборки
appType	Integer	Тип приложения（1:iOS; 2:Android）
appFileSize	Integer	Размер файла приложения
appName	String	Название приложения
appVersion	String	Номер версии
appVersionNo	Integer	Номер версии для Android, всегда 0 для iOS
appBuildVersion	Integer	Номер сборки, используемый PGYER для различения исторических версий
appIdentifier	String	Идентификатор приложения, BundleId для iOS, пакетное имя для Android
appIcon	String	Ключ иконки приложения, адрес доступа: https://www.xcxwo.com/image/view/app_icons/[Ключ иконки приложения]
appCreated	String	Время загрузки приложения

Список групп приложений пользователя

Здесь говорится о группах, которые разработчик устанавливает в разделе "Управление приложениями" - "Мои группы".

URL API

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

Параметры POST

Параметр	Тип	Описание
uKey	String	Ключ пользователяНажмите, чтобы получить_ukey
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
userAppGroupName	String	Название группы приложений
userAppGroupKey	String	Уникальный ключ группы приложений
userAppGroupShortcutURL	String	Короткая ссылка на группу приложений
userAppGroupDescription	String	Описание группы приложений
userAppGroupCount	String	Количество приложений в группе
userAppCreated	String	Время создания группы приложений

Просмотр группы приложений пользователя

Здесь говорится о группах, которые разработчик устанавливает в разделе "Управление приложениями" - "Мои группы".
Этот интерфейс вернет подробную информацию о определенной группе приложений, а также информацию об приложениях в этой группе (показывается только последняя версия).

URL API

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

Параметры POST

Параметр	Тип	Описание
userAppGroupKey	String	Ключ группы приложений пользователя. Можно получить через интерфейс userAppGroup/view.
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
userAppGroupName	String	Название группы приложений
userAppGroupKey	String	Уникальный ключ группы приложений
userAppGroupShortcutURL	String	Короткая ссылка на группу приложений
userAppGroupDescription	String	Описание группы приложений
userAppGroupCount	String	Количество приложений в группе
userAppCreated	String	Время создания группы приложений
apps	Array	Информация о приложениях включенных в группу (возвращается информация о последней версии)

Просмотр списка обратной связи приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
_api_key	String	API Key Нажмите, чтобы получить _api_key
page	Integer	Номер страницы пагинации

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
feedBackContent	String	Содержание обратной связи
feedBackImages	Array	URL изображения обратной связи
feedBackVoice	String	URL аудиофайла обратной связи
feedBackFrom	String	Источник обратной связи
feedbackProcess	Integer	Статус обработки обратной связи (1: обработано; 2: не обработано)
feedBackCreated	String	Время создания обратной связи

Просмотр деталей обратной связи приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
feedbackKey	String	Ключ обратной связи, который можно получить через интерфейс feedbackListAll
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
feedBackContent	String	Содержание обратной связи
feedBackImages	Array	URL изображения обратной связи
feedBackVoice	String	URL аудиофайла обратной связи
feedBackDeviceName	String	Название устройства
feedBackOSVersion	String	Версия операционной системы устройства
feedBackOSType	Integer	Тип операционной системы устройства (1:iOS; 2:Android)
feedBackOSJailBroken	Integer	Устройство взломано или нет (1:да; 2:нет)
feedBackFreeRam	String	Свободная оперативная память устройства
feedBackFreeSpace	String	Свободное место на диске устройства
feedBackNetwork	String	Сеть устройства
feedBackSDKVersion	String	Версия SDK
feedBackFrom	String	Источник обратной связи
feedbackProcess	Integer	Статус обработки обратной связи (1: обработано; 2: не обработано)
appType	Integer	Тип приложения （1:iOS; 2:Android）
appName	String	Название приложения
feedBackCreated	String	Время создания обратной связи

Просмотр списка журналов сбоев приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
_api_key	String	API Key Нажмите, чтобы получить _api_key
page	Integer	Номер страницы пагинации

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
sdkCrashGroupCount	Integer	Crash Количество
sdkCrashGroupTitle	String	Crash Заголовок
sdkCrashGroupPattern	String	Crash Pattern
sdkCrashGroupDescribe	String	Crash Описание
sdkCrashGroupAppVersion	String	Crash App Версия
sdkCrashGroupProcess	String	Crash Статус обработки
sdkCrashGroupId	Integer	CrashGroupId
sdkCrashGroupCreated	String	Crash Время создания

Просмотр подробной информации о журнале сбоя приложения

URL API

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

Параметры POST

Параметр	Тип	Описание
aId	String	App Id
sdkCrashGroupId	Integer	sdkCrashGroupId, Можно получить sdkCrashGroupId для определенного сбоя через crashListAll
_api_key	String	API Key Нажмите, чтобы получить _api_key

Возвращаемые данные

Возвращаемые параметры	Тип	Описание
sdkCrashGroupLog	String	Crash Log
sdkCrashGroupCount	Integer	Crash Количество
sdkCrashGroupTitle	String	Crash Заголовок
sdkCrashGroupPattern	String	Crash Pattern
sdkCrashGroupDescribe	String	Crash Описание
sdkCrashGroupAppVersion	String	Crash App Версия
sdkCrashGroupIsSymbolicated	String	Crash Log Символизировано ли
sdkCrashGroupIsReaded	String	Crash Прочитано ли
sdkCrashGroupProcess	String	Crash Статус обработки
sdkCrashGroupViewStatus	String	Crash Статус просмотра
deviceAffectList	Array	Влияние на устройство
sdkCrashGroupCreated	String	Crash Время создания