Centre de documentation PGYER

API 1.0

Description de l'interface

En utilisant les interfaces fournies par PGYER, les développeurs tiers peuvent intégrer les fonctionnalités de téléchargement, d'hébergement et d'installation d'applications fournies par PGYER dans leurs propres applications, et peuvent également accéder aux diverses données d'application fournies par PGYER via les interfaces de données, facilitant ainsi la distribution d'applications de test interne pour les développeurs.


  1. À moins d'indication contraire, toutes les demandes d'API de données sont effectuées en utilisant la méthode POST HTTP.
  2. La méthode de demande pour obtenir des fichiers de ressources tels que des images est GET HTTP.
  3. L'interface API renvoie le format de données json.
  4. Toutes les demandes d'interface doivent inclure le paramètre API Key afin d'identifier l'identité de l'interface. Cliquez pour obtenir la clé API
PGYER a maintenant lancé l'API 2.0, il est recommandé aux développeurs de l'utiliser, la version 1.0 de l'API ne sera plus maintenue ni mise à jour.

Description des paramètres généraux

Paramètre Épithète Description
_api_key API Key Clé API, utilisée pour identifier l'identité de l'appelant de l'API, sauf indication contraire, ce paramètre est requis dans chaque interface. Pour un utilisateur enregistré sur PGYER, cette valeur est fixe.Cliquez pour obtenir la clé API
uKey User Key Clé utilisateur, utilisée pour identifier l'identité de l'utilisateur actuel, pour un utilisateur enregistré sur PGYER, cette valeur est fixe. Cliquez pour obtenir la clé utilisateur
aId App Id Représente l'ID unique d'un groupe d'applications. Par exemple, si une application nommée "WeChat" a téléchargé trois versions, ces trois versions forment un groupe d'applications, ce paramètre représente l'ID de ce groupe. Cette valeur peut être vue dans le tableau de bord de gestion des applications.
aKey App Key Représente l'identifiant unique d'une application spécifique. Par exemple, si une application nommée "WeChat" télécharge trois versions, ces trois versions auront des aKey différentes, cette valeur est généralement renvoyée par d'autres interfaces.

Code d'exemple

Exemple d'appel PHP à l'interface (voir l'application Square) :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'http://www.pgyer.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=Veuillez vous connecter, une fois connecté, vous pourrez voir&page=1');
$response = curl_exec($curl);
if (curl_errno($curl)) {
    echo curl_error($curl);
}
curl_close($curl);
$jsonData = json_decode($response, true);
// output $jsonData ...

Télécharger une application

Avec cette interface, les développeurs peuvent télécharger directement une application sur PGYER. Lors de l'envoi, veuillez utiliser la méthode POST HTTP, avec enctype "multipart/form-data"

URL de l'API

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

Paramètres POST

Paramètre Type Description
uKey String (Obligatoire) Clé utilisateur Cliquez pour obtenir la clé utilisateur
_api_key String (Obligatoire) Clé API Cliquez pour obtenir la clé API
file File (obligatoire) Fichier IPA ou APK à télécharger
installType Integer (Optionnel) Type d'installation de l'application, les valeurs possibles sont (1,2,3). 1: Public, 2: Installation par mot de passe, 3: Installation par invitation. Par défaut, c'est 1: Public
password String (optionnel) Définir le mot de passe d'installation de l'application, si vous ne souhaitez pas définir de mot de passe, veuillez transmettre une chaîne vide ou ne pas transmettre.
updateDescription String (optionnel) Description de la mise à jour de la version, veuillez transmettre une chaîne vide ou ne pas transmettre.
channelShortcut String (optionnel) Lien court de téléchargement pour le canal spécifié à mettre à jour, seul un canal peut être spécifié, de type chaîne, par exemple: abcd.

Données de retour

Paramètre Type Description
appKey String App Key
userKey String User Key
appType Integer Type d'application(1:iOS; 2:Android)
appIsFirst Integer Est-ce le premier App (1: oui; 2: non)
appIsLastest Integer Est-ce la dernière version (1: oui; 2: non)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appDescription String Description de l'application
appUpdateDescription String Description de la mise à jour de l'application
appScreenShots String Clé de la capture d'écran de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_screenshots/[Clé de la capture d'écran de l'application]
appShortcutUrl String URL de téléchargement de l'application
appQRCodeURL String URL du code QR de l'application
appCreated String Heure de téléchargement de l'application
appUpdated String Heure de mise à jour de l'application

Exemple de téléchargement de l'application

Exemple de téléchargement de l'application en utilisant la commande crul sous Linux:

curl -F "file=@/tmp/example.ipa" -F "uKey=Veuillez vous connecter, une fois connecté, vous pourrez voir" -F "_api_key=Veuillez vous connecter, une fois connecté, vous pourrez voir" http://upload.pgyer.com/apiv1/app/upload

Veuillez remplacer les valeurs de uKey et _api_key par les valeurs correspondantes de votre compte développeur.

Installer l'application

Vous pouvez installer directement l'application sur votre téléphone en utilisant cette interface, veuillez utiliser la méthode HTTP GET. Cette interface est uniquement disponible sur les téléphones, veuillez ouvrir ce lien dans le navigateur de votre téléphone pour commencer l'installation.

URL de l'API

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

Paramètres GET

Paramètre Description
aKey App Key (La clé de l'application est l'identifiant unique de l'application, vous pouvez l'obtenir via l'interface de lien court ou l'interface de mes applications)
_api_key API Key Cliquez pour obtenir la clé API
password (Facultatif) Lorsque l'application nécessite un mot de passe d'installation, veuillez fournir le mot de passe d'installation de l'application

Données de retour

L'interface installera automatiquement l'application en fonction du type d'application (iOS ou Android).

Code d'exemple

http://www.pgyer.com/apiv1/app/install?_api_key=Veuillez vous connecter, une fois connecté, vous pourrez voir&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456

Installation dans l'application iOS

L'interface d'installation dans l'application iOS permet à l'utilisateur d'installer l'application sans ouvrir le navigateur. URL de l'interface :

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

Veuillez remplacer {aKey} par la clé de l'application, sans les accolades.

Code d'exemple

Web:

<a href="itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/f3c7897cf8ac70a3d345699ef6e1584d>Installer</a>
iOS:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/f3c7897cf8ac70a3d345699ef6e1584d"]];
Ou:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.pgyer.com/apiv1/app/install?_api_key=Veuillez vous connecter, une fois connecté, vous pourrez voir&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456"]];

Obtenir des informations détaillées sur l'application

Cette interface permet d'obtenir des informations détaillées sur une version spécifique d'une application.

URL de l'API

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

Paramètres POST

Paramètre Type Description
aKey String (La clé de l'application est l'identifiant unique de l'application, vous pouvez l'obtenir via l'interface de lien court ou l'interface de mes applications)
uKey String (Facultatif) Clé de l'utilisateurCliquez pour obtenir la clé utilisateur
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour des détails de l'application Type Description
appKey String App Key
userKey String User Key
appType Integer Type d'application(1:iOS; 2:Android)
appIsFirst Integer Est-ce le premier App (1: oui; 2: non)
appIsLastest Integer Est-ce la dernière version (1: oui; 2: non)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appDescription String Description de l'application
appUpdateDescription String Description de la mise à jour de l'application
appScreenShots String Clé de la capture d'écran de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_screenshots/[Clé de la capture d'écran de l'application]
appShortcutUrl String URL de téléchargement de l'application
appQRCodeURL String URL du code QR de l'application
appCreated String Heure de téléchargement de l'application
appUpdated String Heure de mise à jour de l'application
Paramètres de retour des versions antérieures Type Description
appKey String App Key
userKey String User Key
appName String Nom de l'application
appVersion String Numéro de version
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appCreated String Heure de téléchargement de l'application
appUpdated String Heure de mise à jour de l'application
Paramètres de retour des commentaires sur l'application Type Description
userKey Integer User Key
commentContent Integer Contenu des commentaires
commentImageKeys Integer Clé de la capture d'écran dans les commentaires, l'adresse d'accès est :https://www.pgyer.com/image/view/comment_screenshot/[Clé de la capture d'écran dans les commentaires]
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier Integer Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appCreated Integer Heure de téléchargement de l'application
appUpdated Integer Heure de mise à jour de l'application

Obtenir des informations détaillées sur le groupe d'applications

Pour différentes versions d'une même application, PGYER les regroupe pour former un ensemble d'applications que nous appelons un "groupe d'applications". Chaque groupe d'applications est associé à un identifiant d'application unique. Cette API est utilisée pour obtenir des informations détaillées sur un groupe d'applications.

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour des détails de l'application Type Description
appKey String App Key
appType Integer Type d'application(1:iOS; 2:Android)
appIsFirst Integer Est-ce le premier App (1: oui; 2: non)
appIsLastest Integer Est-ce la dernière version (1: oui; 2: non)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appDescription String Description de l'application
appUpdateDescription String Description de la mise à jour de l'application
appScreenShots String Clé de la capture d'écran de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_screenshots/[Clé de la capture d'écran de l'application]
appShortcutUrl String URL de téléchargement de l'application
appQRCodeURL String URL du code QR de l'application
appCreated String Heure de téléchargement de l'application
appUpdated String Heure de mise à jour de l'application

Modifier les informations détaillées sur l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aKey String App Key (La clé de l'application est l'identifiant unique de l'application, vous pouvez l'obtenir via l'interface de lien court ou l'interface de mes applications)
uKey String Clé utilisateurCliquez pour obtenir la clé utilisateur
_api_key String API Key Cliquez pour obtenir la clé API
appName String (Facultatif) Nom de l'application
appShortcutUrl String (Facultatif) URL de téléchargement de l'application
appUpdateDescription String (Facultatif, laisser vide pour effacer) Description de la mise à jour de l'application
appDescription String (Facultatif, laisser vide pour effacer) Description de l'application
appPassword String (Facultatif, laisser vide pour effacer) Définir le mot de passe de l'application
appVersion String (Facultatif) Informations sur la version de l'application
appScreenshots String (Facultatif, laisser vide pour effacer) Clé de capture d'écran de l'application

Données de retour

Paramètres de retour Type Description
appKey String App Key
userKey String User Key
appType Integer Type d'application(1:iOS; 2:Android)
appIsFirst Integer Est-ce le premier App (1: oui; 2: non)
appIsLastest Integer Est-ce la dernière version (1: oui; 2: non)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appDescription String Description de l'application
appUpdateDescription String Description de la mise à jour de l'application
appScreenShots String Clé de la capture d'écran de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_screenshots/[Clé de la capture d'écran de l'application]
appShortcutUrl String URL de téléchargement de l'application
appQRCodeURL String URL du code QR de l'application
appCreated String Heure de téléchargement de l'application
appUpdated String Heure de mise à jour de l'application

Obtenir toutes les versions de l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
page Integer Numéro de page de pagination de l'historique des versions
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
appKey String Retourne la clé de l'application la plus récente
appType Integer Type d'application(1:iOS; 2:Android)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appCreated String Heure de téléchargement de l'application

Télécharger des captures d'écran de l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aKey String App Key (La clé de l'application est l'identifiant unique de l'application, vous pouvez l'obtenir via l'interface de lien court ou l'interface de mes applications)
_api_key String API Key Cliquez pour obtenir la clé API
image File Captures d'écran à télécharger, jusqu'à 5 maximum

Données de retour

Paramètres de retour Type Description
keys String Toutes les clés des captures d'écran une fois téléchargées (séparées par des virgules), l'URL de récupération est https://www.pgyer.com/image/view/app_screenshots/[Clé de la capture d'écran de l'application]

Obtenir des informations sur l'application en utilisant un lien court

URL de l'API

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

Paramètres POST

Paramètre Type Description
shortcut String Lien court de l'application, par exemple pgyer.com/PgY8, il suffit de transmettre le paramètre PgY8
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour des détails de l'application Type Description
appKey String Retourne la clé de l'application la plus récente
appType Integer Type d'application(1:iOS; 2:Android)
appFileName String Nom du fichier de l'application téléchargée
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appCreated String Heure de téléchargement de l'application

Voir les applications que j'ai téléchargées

URL de l'API

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

Paramètres POST

Paramètre Type Description
uKey String Clé utilisateurCliquez pour obtenir la clé utilisateur
page Integer (Facultatif) Indiquer le nombre de pages en chiffres
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
appKey String Retourne la clé de l'application la plus récente
appType Integer Type d'application(1:iOS; 2:Android)
appFileSize Integer Taille de l'application
appName String Nom de l'application
appVersion String Numéro de version
appVersionNo Integer Numéro de version pour Android, toujours 0 pour iOS
appBuildVersion Integer Numéro de build généré par PGYER pour distinguer les versions précédentes
appIdentifier String Nom du package de l'application, BundleId pour iOS, nom du package pour Android
appIcon String Clé de l'icône de l'application, l'adresse d'accès est https://www.pgyer.com/image/view/app_icons/[Clé de l'icône de l'application]
appCreated String Heure de téléchargement de l'application

Lister les groupes d'applications de l'utilisateur

Ici, les groupes font référence aux groupes d'applications définis par le développeur dans "Gestion des applications" - "Mes groupes".

URL de l'API

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

Paramètres POST

Paramètre Type Description
uKey String Clé utilisateurCliquez pour obtenir la clé utilisateur
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
userAppGroupName String Nom du groupe d'applications
userAppGroupKey String Clé unique du groupe d'applications
userAppGroupShortcutURL String Lien court du groupe d'applications
userAppGroupDescription String Description du groupe d'applications
userAppGroupCount String Nombre d'applications dans le groupe d'applications
userAppCreated String Heure de création du groupe d'applications

Voir les groupes d'applications de l'utilisateur

Ici, les groupes font référence aux groupes d'applications définis par le développeur dans "Gestion des applications" - "Mes groupes".
Cette API renverra des informations détaillées sur un groupe d'applications spécifique, ainsi que les informations sur les applications incluses dans ce groupe (seule la dernière version est répertoriée).

URL de l'API

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

Paramètres POST

Paramètre Type Description
userAppGroupKey String Clé du groupe d'applications de l'utilisateur. Peut être obtenu via l'API userAppGroup/view.
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
userAppGroupName String Nom du groupe d'applications
userAppGroupKey String Clé unique du groupe d'applications
userAppGroupShortcutURL String Lien court du groupe d'applications
userAppGroupDescription String Description du groupe d'applications
userAppGroupCount String Nombre d'applications dans le groupe d'applications
userAppCreated String Heure de création du groupe d'applications
apps Array Informations sur les applications incluses (retourne les informations sur la dernière version)

Voir la liste des retours d'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
_api_key String API Key Cliquez pour obtenir la clé API
page Integer Numéro de page de pagination

Données de retour

Paramètres de retour Type Description
feedBackContent String Contenu des commentaires
feedBackImages Array Adresse de l'image dans les commentaires
feedBackVoice String Adresse du fichier audio
feedBackFrom String Source des commentaires
feedbackProcess Integer État de traitement des commentaires (1:Traité; 2:Non traité)
feedBackCreated String Date de création du feedback

Voir les détails des commentaires de l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
feedbackKey String Clé d'information du feedback, peut être obtenue via l'interface feedbackListAll
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
feedBackContent String Contenu des commentaires
feedBackImages Array Adresse de l'image dans les commentaires
feedBackVoice String Adresse du fichier audio
feedBackDeviceName String Nom de l'appareil
feedBackOSVersion String Version du système d'exploitation du téléphone
feedBackOSType Integer Type de système d'exploitation du téléphone (1:iOS; 2:Android)
feedBackOSJailBroken Integer Le téléphone est-il jailbreaké ou ROOTé (1:Oui; 2:Non)
feedBackFreeRam String Taille de la mémoire libre du téléphone
feedBackFreeSpace String Taille de l'espace disque libre du téléphone
feedBackNetwork String Réseau du téléphone
feedBackSDKVersion String Version du SDK
feedBackFrom String Source des commentaires
feedbackProcess Integer État de traitement des commentaires (1:Traité; 2:Non traité)
appType Integer Type d'application (1:iOS; 2:Android)
appName String Nom de l'application
feedBackCreated String Date de création du feedback

Voir la liste des journaux de crash de l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
_api_key String API Key Cliquez pour obtenir la clé API
page Integer Numéro de page de pagination

Données de retour

Paramètres de retour Type Description
sdkCrashGroupCount Integer Crash Nombre
sdkCrashGroupTitle String Crash Titre
sdkCrashGroupPattern String Crash Pattern
sdkCrashGroupDescribe String Crash Description
sdkCrashGroupAppVersion String Crash App Version
sdkCrashGroupProcess String Crash État du traitement
sdkCrashGroupId Integer CrashGroupId
sdkCrashGroupCreated String Crash Date de création

Voir les détails du journal de crash de l'application

URL de l'API

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

Paramètres POST

Paramètre Type Description
aId String App Id
sdkCrashGroupId Integer sdkCrashGroupId, Peut être obtenu via crashListAll pour un sdkCrashGroupId spécifique
_api_key String API Key Cliquez pour obtenir la clé API

Données de retour

Paramètres de retour Type Description
sdkCrashGroupLog String Crash Log
sdkCrashGroupCount Integer Crash Nombre
sdkCrashGroupTitle String Crash Titre
sdkCrashGroupPattern String Crash Pattern
sdkCrashGroupDescribe String Crash Description
sdkCrashGroupAppVersion String Crash App Version
sdkCrashGroupIsSymbolicated String Crash Log Est symbolisé
sdkCrashGroupIsReaded String Crash Est lu
sdkCrashGroupProcess String Crash État du traitement
sdkCrashGroupViewStatus String Crash État de visualisation
deviceAffectList Array Impact sur les appareils
sdkCrashGroupCreated String Crash Date de création