Electron アプリ - アップグレード戦略の取得
API 説明：クライアントのバージョン番号に基づいて、対応するアップグレード戦略を取得します。Electron 公式が提供するアップグレードインターフェースと互換性があります。
📮 リクエスト情報
リクエスト URL
GET http://0.0.0.0:8888/v1/electron/upgrade?electronKey=kPUtUMDIjBhS48q5771pow&versionName=1.1.1&appointVersionName=&devModelKey=&devKey=&platform=darwin&arch=arm64
リクエストヘッダー
| パラメータ名 | 必須 | 型 | 例 | 説明 |
|---|---|---|---|---|
| X-AccessKey | Yes | string | mui2W50H1j-OC4xD6PgQag | シークレットキー AccessKey |
リクエストパラメータ
| パラメータ名 | 必須 | 型 | 例 | 説明 |
|---|---|---|---|---|
| electronKey | Yes | string | kPUtUMDIjBhS48q5771pow | Electron アプリの一意の識別子 |
| versionName | Yes | string | 1.0.0 | バージョン番号 |
| appointVersionName | No | string | 1.2.0 | 希望するアップグレードバージョン名、指定なしで最新バージョン |
| devModelKey | No | string | stv1 | デバイスモデルの一意の識別子 |
| devKey | No | string | LOYlLXNy7w | デバイスの一意の識別子（MAC アドレスを一意の識別子として使用できます） |
| platform | Yes | string | linux | オペレーティングシステム: linux, darwin, windows |
| arch | Yes | string | x64 | マシンアーキテクチャ: x64, arm64 |
📮 レスポンス情報
成功レスポンスボディ
json
{
"upgradeType": 1,
"promptUpgradeContent": "アップグレード通知コンテンツ",
"version": "1.2.0",
"files": [
{
"url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
"sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
"size": 153453614
},
{
"url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
"sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
"size": 153453614
}
],
"path": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
"sha512": "sSrgmnph5Cr2AuZwCEWXD90JiJ2JW0RnqLf8cXSxusHLssCPRlAFtpER74Rlw/LglbOlcYvh+IO3jsAxAdLQmw==",
"releaseDate": ""
}成功レスポンスボディ（既に最新バージョンの場合）
json
{
"promptUpgradeContent": "既に最新バージョンです",
"version": "1.0.0"
}システムが要求されたバージョンが既に最新であると判断した場合、version フィールドには現在要求されている versionName が返されます。
レスポンスボディパラメータ
返される内容は、公式にパッケージされた yml ファイルの内容と一致しています。
| パラメータ名 | 型 | 例 | 説明 |
|---|---|---|---|
| upgradeType | int | 1 | アップグレード通知タイプ: 1: プロンプトアップグレード; 2: サイレントアップグレード; 3: 強制アップグレード |
| prompt_upgrade_content | string | アップグレード通知コンテンツ | アップグレード通知コンテンツ |
| version | string | 1.0.0 | バージョン番号 |
| path | string | ダウンロードパス | 更新ファイルのダウンロードパス |
| sha512 | string | SHA512 チェックサム | 更新ファイルの sha512 チェックサム |
典型的なエラーレスポンスボディ
json
{
"code": 404001,
"msg": "利用可能なバージョンが取得できません",
"docs": "対応するアプリケーションバージョンが見つかりません。システムに正しく作成されているか確認してください。ドキュメントを参照してください：https://upgrade.toolsetlink.com/ja/upgrade/recommend/electron/app-version.html",
"data": null
}📊 ステータスコード
| HTTP ステータスコード | コード | シナリオ説明 | 解決策 |
|---|---|---|---|
| 200 | リクエスト成功、バージョンアップグレード戦略を取得 | ||
| 400 | 400001 | 無効なリクエスト | |
| 400 | 400002 | パラメータが不足しています | |
| 400 | 400003 | 無効なパラメータ | |
| 400 | 400004 | 無効なヘッダー | |
| 400 | 400005 | 無効なボディ | |
| 401 | 401001 | 認証に失敗しました | |
| 401 | 401002 | 署名検証に失敗しました | |
| 404 | 404001 | リソースが見つかりません | |
| 404 | 404002 | レコードが見つかりません | |
| 404 | 404003 | 処理方法が見つかりません | |
| 404 | 404004 | リクエストが見つかりません | |
| 429 | 429001 | アプリケーションタスク戦略のリクエストレート制限 | 現在のアップグレードタスクに設定されているリクエストレート制限に達しました。後でもう一度お試しください。 |
| 500 | 500001 | サーバー内部エラー | お問い合わせください お問い合わせ |
| 500 | 500002 | サーバー内部データ検証に失敗しました | お問い合わせください お問い合わせ |