PGYERドキュメントセンター
PGYERが提供するインターフェースを利用することで、サードパーティーの開発者はPGYERが提供するアプリのアップロード、ホスティング、インストールなどの機能を自分のアプリに組み込むことができます。また、データインターフェースを使用して、PGYERが提供するさまざまなアプリデータを取得し、開発者が内部テストアプリの配布をより簡単に行えるようにします。
パラメータ | 別名 | 説明 |
---|---|---|
_api_key | API Key | APIキーは、API呼び出し元の身元を識別するために使用されます。特に指定がない限り、すべてのAPIにこのパラメータを含める必要があります。PGYERの登録ユーザーにとって、この値は固定されています。_api_keyを取得するにはここをクリックしてください |
uKey | User Key | ユーザーキーは、現在のユーザーの身元を識別するために使用されます。PGYERの登録ユーザーにとって、この値は固定されています。 _ukeyを取得するにはここをクリックしてください |
aId | App Id | Appグループの一意のIDを表します。たとえば、「WeChat」という名前のAppが3つのバージョンをアップロードした場合、これらの3つのバージョンは1つのAppグループとなり、このパラメータはそのグループのIDを表します。この値はアプリ管理画面で確認できます。 |
aKey | App Key | 特定のAppを一意に識別するもの。例えば、"WeChat"という名前のAppが3つのバージョンをアップロードした場合、それぞれのバージョンに異なるaKeyがあります。この値は通常、他のAPIから返されます。 |
PHPを使用してAPIを呼び出す例(アプリケーションの広場を表示):
$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=ログインしてください。ログイン後に確認できます&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を使用すると、開発者は直接AppをPGYERにアップロードできます。アップロードする際は、HTTP POSTメソッドを使用し、enctypeを "multipart/form-data"に設定してください。
POST https://upload.pgyer.com/apiv1/app/upload
パラメータ | タイプ | 説明 |
---|---|---|
uKey | String | (必須) ユーザーKey _ukeyを取得するにはここをクリックしてください |
_api_key | String | (必須) API Key _api_keyを取得するにはここをクリックしてください |
file | File | (必須) アップロードするipaまたはapkファイル |
installType | Integer | (オプション)アプリのインストール方法、値は(1,2,3)。1:公開、2:パスワードインストール、3:招待インストール。デフォルトは1公開 |
password | String | (オプション) アプリのインストールパスワードを設定します。パスワードを設定したくない場合は、空の文字列を渡すか、渡さないでください。 |
updateDescription | String | (オプション) バージョン更新の説明。空の文字列を渡すか、渡さないでください。 |
channelShortcut | String | (オプション) 更新する特定のチャネルのダウンロードショートカットが必要です。1つのチャネルのみを指定できます。文字列型、例: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用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appDescription | String | アプリの説明 |
appUpdateDescription | String | アプリの更新説明 |
appScreenShots | String | アプリのスクリーンショットキー、取得URLは https://www.pgyer.com/image/view/app_screenshots/[アプリのスクリーンショットキー] |
appShortcutUrl | String | アプリの短縮URL |
appQRCodeURL | String | アプリのQRコードURL |
appCreated | String | アプリのアップロード時間 |
appUpdated | String | アプリの更新時間 |
Linuxのcrulコマンドを使用してアプリをアップロードする例:
curl -F "file=@/tmp/example.ipa" -F "uKey=ログインしてください。ログイン後に確認できます" -F "_api_key=ログインしてください。ログイン後に確認できます" https://upload.pgyer.com/apiv1/app/upload
開発者のアカウントに応じて、uKeyと_api_keyの値を適切な値に置き換えてください。
このインターフェースを使用して、携帯電話に直接アプリをインストールできます。HTTP GET方式を使用してください。このインターフェースは携帯電話でのみ利用可能で、携帯電話のブラウザでこのアドレスにリクエストするとインストールが開始されます。
GET http://www.pgyer.com/apiv1/app/install
パラメータ | 説明 |
---|---|
aKey | App Key (App Keyはアプリを一意に識別するインデックスIDであり、短縮URLインターフェースまたはマイアプリインターフェースを使用して取得できます) |
_api_key | API Key _api_keyを取得するにはここをクリックしてください |
password | (オプション) アプリのインストールパスワードが必要な場合は、アプリのインストールパスワードを渡してください |
アプリの種類(iOSまたはAndroid)に応じて、自動的に対応するインストール方法を使用してアプリをインストールします。
http://www.pgyer.com/apiv1/app/install?_api_key=ログインしてください。ログイン後に確認できます&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456
iOSアプリ内インストールAPIを使用すると、ユーザーがアプリをインストールする際にブラウザを開かずに直接インストールできます。APIアドレス:
itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/{aKey}
中の{aKey}
をAppのキーに置き換えてください。中括弧は含まれません。
Web:
<a href="itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/f3c7897cf8ac70a3d345699ef6e1584d>インストール</a>iOS:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"itms-services://?action=download-manifest&url=https://www.pgyer.com/app/plist/f3c7897cf8ac70a3d345699ef6e1584d"]];または:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.pgyer.com/apiv1/app/install?_api_key=ログインしてください。ログイン後に確認できます&aKey=f3c7897cf8ac70a3d345699ef6e1584d&password=123456"]];
このAPIを使用すると、特定のAppの特定のバージョンの詳細情報を取得できます。
POST http://www.pgyer.com/apiv1/app/view
パラメータ | タイプ | 説明 |
---|---|---|
aKey | String | (App Keyはアプリを一意に識別するインデックスIDであり、短縮URLインターフェースまたはマイアプリインターフェースを使用して取得できます) |
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用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appDescription | String | アプリの説明 |
appUpdateDescription | String | アプリの更新説明 |
appScreenShots | String | アプリのスクリーンショットキー、取得URLは https://www.pgyer.com/image/view/app_screenshots/[アプリのスクリーンショットキー] |
appShortcutUrl | String | アプリの短縮URL |
appQRCodeURL | String | アプリのQRコードURL |
appCreated | String | アプリのアップロード時間 |
appUpdated | String | アプリの更新時間 |
過去のバージョンの返り値 | タイプ | 説明 |
---|---|---|
appKey | String | App Key |
userKey | String | User Key |
appName | String | アプリ名 |
appVersion | String | バージョン番号 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appCreated | String | アプリのアップロード時間 |
appUpdated | String | アプリの更新時間 |
アプリフィードバックの返り値 | タイプ | 説明 |
---|---|---|
userKey | Integer | User Key |
commentContent | Integer | フィードバック内容 |
commentImageKeys | Integer | フィードバックのスクリーンショットキー、アクセスURLは:https://www.pgyer.com/image/view/comment_screenshot/[フィードバックのスクリーンショットキー] |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | Integer | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appCreated | Integer | アプリのアップロード時間 |
appUpdated | Integer | アプリの更新時間 |
同じAppの異なるバージョンは、PGYERがそれらを統合してAppのコレクションを作成し、これを"Appグループ"と呼びます。"Appグループ"には、それに対応する一意のApp Idがあります。このインターフェースは、Appグループの詳細情報を取得するために使用されます。
POST http://www.pgyer.com/apiv1/app/viewGroup
パラメータ | タイプ | 説明 |
---|---|---|
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用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appDescription | String | アプリの説明 |
appUpdateDescription | String | アプリの更新説明 |
appScreenShots | String | アプリのスクリーンショットキー、取得URLは https://www.pgyer.com/image/view/app_screenshots/[アプリのスクリーンショットキー] |
appShortcutUrl | String | アプリの短縮URL |
appQRCodeURL | String | アプリのQRコードURL |
appCreated | String | アプリのアップロード時間 |
appUpdated | String | アプリの更新時間 |
POST http://www.pgyer.com/apiv1/app/update
パラメータ | タイプ | 説明 |
---|---|---|
aKey | String | App Key (App Keyはアプリを一意に識別するインデックスIDであり、短縮URLインターフェースまたはマイアプリインターフェースを使用して取得できます) |
uKey | String | ユーザーKey_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用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appDescription | String | アプリの説明 |
appUpdateDescription | String | アプリの更新説明 |
appScreenShots | String | アプリのスクリーンショットキー、取得URLは https://www.pgyer.com/image/view/app_screenshots/[アプリのスクリーンショットキー] |
appShortcutUrl | String | アプリの短縮URL |
appQRCodeURL | String | アプリのQRコードURL |
appCreated | String | アプリのアップロード時間 |
appUpdated | String | アプリの更新時間 |
POST http://www.pgyer.com/apiv1/app/builds
パラメータ | タイプ | 説明 |
---|---|---|
aId | String | App Id |
page | Integer | 履歴バージョンのページ数 |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
appKey | String | 最新のビルドのApp Keyを返す |
appType | Integer | アプリの種類(1:iOS; 2:Android) |
appFileSize | Integer | アプリファイルサイズ |
appName | String | アプリ名 |
appVersion | String | バージョン番号 |
appVersionNo | Integer | Android用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appCreated | String | アプリのアップロード時間 |
POST http://www.pgyer.com/apiv1/app/uploadScreenshot
パラメータ | タイプ | 説明 |
---|---|---|
aKey | String | App Key (App Keyはアプリを一意に識別するインデックスIDであり、短縮URLインターフェースまたはマイアプリインターフェースを使用して取得できます) |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
image | File | アップロードするスクリーンショット、最大5枚まで |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
keys | String | アプリのアップロード後のすべてのスクリーンショットキー(コンマ区切り)、取得URLは https://www.pgyer.com/image/view/app_screenshots/[アプリのスクリーンショットキー] |
POST http://www.pgyer.com/apiv1/app/getAppKeyByShortcut
パラメータ | タイプ | 説明 |
---|---|---|
shortcut | String | アプリの短縮URL、例:pgyer.com/PgY8、PgY8のパラメータのみを渡す |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
アプリの詳細情報の返り値 | タイプ | 説明 |
---|---|---|
appKey | String | 最新のビルドのApp Keyを返す |
appType | Integer | アプリの種類(1:iOS; 2:Android) |
appFileName | String | アップロードするアプリのファイル名 |
appFileSize | Integer | アプリファイルサイズ |
appName | String | アプリ名 |
appVersion | String | バージョン番号 |
appVersionNo | Integer | Android用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appCreated | String | アプリのアップロード時間 |
POST http://www.pgyer.com/apiv1/user/listMyPublished
パラメータ | タイプ | 説明 |
---|---|---|
uKey | String | ユーザーKey_ukeyを取得するにはここをクリックしてください |
page | Integer | (オプション) ページ数を入力してください |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
appKey | String | 最新のビルドのApp Keyを返す |
appType | Integer | アプリの種類(1:iOS; 2:Android) |
appFileSize | Integer | アプリファイルサイズ |
appName | String | アプリ名 |
appVersion | String | バージョン番号 |
appVersionNo | Integer | Android用のバージョン番号、iOSは常に0 |
appBuildVersion | Integer | 過去のバージョンを区別するためにPGYERが生成したbuild番号 |
appIdentifier | String | アプリのパッケージ名、iOSはBundleId、Androidはパッケージ名 |
appIcon | String | アプリのアイコンキー、アクセスURLは https://www.pgyer.com/image/view/app_icons/[アプリのアイコンキー] |
appCreated | String | アプリのアップロード時間 |
ここで言及されているグループとは、開発者が「アプリ管理」-「マイグループ」で設定したAppグループを指します。
POST http://www.pgyer.com/apiv1/userAppGroup/listAll
パラメータ | タイプ | 説明 |
---|---|---|
uKey | String | ユーザーKey_ukeyを取得するにはここをクリックしてください |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
userAppGroupName | String | Appグループ名 |
userAppGroupKey | String | Appグループの一意の識別キー |
userAppGroupShortcutURL | String | Appグループの短縮URL |
userAppGroupDescription | String | Appグループの説明 |
userAppGroupCount | String | Appグループ内のAppの数 |
userAppCreated | String | Appグループの作成時間 |
ここで言及されているグループとは、開発者が「アプリ管理」-「マイグループ」で設定したAppグループを指します。
このAPIは特定のAppグループの詳細情報を返し、そのグループに含まれるApp情報(最新バージョンのみ)も返します。
POST http://www.pgyer.com/apiv1/userAppGroup/view
パラメータ | タイプ | 説明 |
---|---|---|
userAppGroupKey | String | ユーザーのAppグループのキー。userAppGroup/view APIを使用して取得できます。 |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
userAppGroupName | String | Appグループ名 |
userAppGroupKey | String | Appグループの一意の識別キー |
userAppGroupShortcutURL | String | Appグループの短縮URL |
userAppGroupDescription | String | Appグループの説明 |
userAppGroupCount | String | Appグループ内のAppの数 |
userAppCreated | String | Appグループの作成時間 |
apps | Array | 含まれるApp情報(最新バージョン情報を返します) |
POST http://www.pgyer.com/apiv1/feedback/listAll
パラメータ | タイプ | 説明 |
---|---|---|
aId | String | App Id |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
page | Integer | ページ番号 |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
feedBackContent | String | フィードバック内容 |
feedBackImages | Array | フィードバック情報の画像アドレス |
feedBackVoice | String | 音声ファイルアドレス |
feedBackFrom | String | フィードバック情報の出所 |
feedbackProcess | Integer | フィードバック処理状態(1:処理済み; 2:未処理) |
feedBackCreated | String | フィードバック作成日時 |
POST http://www.pgyer.com/apiv1/feedback/view
パラメータ | タイプ | 説明 |
---|---|---|
aId | String | App Id | feedbackKey | String | フィードバック情報のキー、feedbackListAllインターフェースを使用して取得できます |
_api_key | String | API Key _api_keyを取得するにはここをクリックしてください |
返り値のパラメータ | タイプ | 説明 |
---|---|---|
feedBackContent | String | フィードバック内容 |
feedBackImages | Array | フィードバック情報の画像アドレス |
feedBackVoice | String | 音声ファイルアドレス |
feedBackDeviceName | String | デバイス名 |
feedBackOSVersion | String | 携帯電話のシステムバージョン |
feedBackOSType | Integer | 携帯電話のシステムタイプ(1:iOS; 2:Android) |
feedBackOSJailBroken | Integer | 携帯電話がジェイルブレイクまたはROOTされているか(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 | フィードバック作成日時 |
POST http://www.pgyer.com/apiv1/crash/listAll
パラメータ | タイプ | 説明 |
---|---|---|
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 作成日時 |
POST http://www.pgyer.com/apiv1/crash/view
パラメータ | タイプ | 説明 |
---|---|---|
aId | String | App Id |
sdkCrashGroupId | Integer | sdkCrashGroupId, crashListAllからsdkCrashGroupIdを取得できます |
_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 作成日時 |