Windows アプリケーションバージョン詳細

API 説明：クライアントのバージョン番号に基づいて、対応するバージョンの詳細を取得します

📮 リクエスト情報

リクエスト URL

POST https://api.upgrade.toolsetlink.com/v1/win/version

リクエストヘッダー

パラメータ名	必須	型	例	説明
X-Timestamp	Yes	string	2025-02-17T10:34:55+08:00	RFC3339 形式のリクエスト時間
X-Nonce	Yes	string	fc812cc0b9b51e8c	一意のランダム文字列（少なくとも 16 文字）
X-AccessKey	Yes	string	mui2W50H1j-OC4xD6PgQag	シークレットキー AccessKey
X-Signature	Yes	string	3603437250c2df51fc46426ac79d8995	リクエスト署名 署名ルール
Content-Type	Yes	string	application/json

🔐 リプレイ攻撃防止メカニズム

1. サーバーは、サーバー時間とのタイムスタンプの差が ±5 分を超えないことを検証します
2. サーバーは、Nonce 値が既に存在するかどうかを確認します（重複リクエストを防止するため）

リクエストボディ

{
  "winKey": "isVZBUvkFhv6oHxk_X-D0Q",
  "versionCode": 1,
  "arch": "x64"
}

リクエストボディパラメータ説明

パラメータ名	必須	型	例	説明
winKey	Yes	string	isVZBUvkFhv6oHxk_X-D0Q	Windows アプリケーションの一意の識別子
versionCode	Yes	int	1	クライアントバージョンコード
arch	Yes	string	x64	マシンアーキテクチャ: x64, arm64

📮 レスポンス情報

成功レスポンスボディ

{
  "code": 200,
  "msg": "バージョン詳細が見つかりました",
  "data": {
    "winKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "packageName": "com.a.c",
    "versionName": "v2",
    "versionCode": 2,
    "description": "説明コンテンツ",
    "pubDate": "2024-02-17T10:34:55+08:00",
    "arch": "x64",
    "releaseNote": "リリースノートコンテンツ",
    "changelog": "チェンジログコンテンツ",
    "upgradeMode": 1,
    "forcedUpgradeVersionCode": 1,
    "silentUpgradeVersionCode": 1,
    "target": "win",
    "releaseUrl": "https://example.com/windows-app-v2.exe",
    "updateType": "manual",
    "md5": "md5 値",
    "sha256": "sha256 値",
    "downloadUrl": "https://example.com/windows-app-v2.exe",
    "fileSize": 1024000,
    "downloadTimes": 100,
    "isPreRelease": false
  }
}

レスポンスボディパラメータ説明

パラメータ名	型	例	説明
winKey	string	isVZBUvkFhv6oHxk_X-D0Q	Windows アプリケーションの一意の識別子
packageName	string	com.a.c	Windows アプリケーションのパッケージ名
versionName	string	v2	バージョン名
versionCode	int	2	バージョンコード
description	string	説明コンテンツ	説明
pubDate	string	2024-02-17T10:34:55+08:00	公開日
arch	string	x64	マシンアーキテクチャ
releaseNote	string	リリースノートコンテンツ	リリースノート
changelog	string	チェンジログコンテンツ	チェンジログ
upgradeMode	int	1	アップグレードモード
forcedUpgradeVersionCode	int	1	強制アップグレードバージョンコード
silentUpgradeVersionCode	int	1	サイレントアップグレードバージョンコード
target	string	win	ターゲットプラットフォーム
releaseUrl	string	https://example.com/windows-app-v2.exe	リリース URL
updateType	string	manual	更新タイプ
md5	string	md5 値	MD5 チェックサム
sha256	string	sha256 値	SHA256 チェックサム
downloadUrl	string	https://example.com/windows-app-v2.exe	ダウンロード URL
fileSize	int	1024000	ファイルサイズ（バイト）
downloadTimes	int	100	ダウンロード回数
isPreRelease	boolean	false	プレリリースかどうか

典型的なエラーレスポンスボディ

{
  "code": 404001,
  "msg": "利用可能なバージョンが見つかりません",
  "docs": "対応するアプリケーションバージョンが見つかりません。システムに正しく作成されているか確認してください。ドキュメントを参照してください：https://upgrade.toolsetlink.com/ja/upgrade/recommend/win/app-version.html",
  "data": null
}

📊 ステータスコード

HTTP ステータスコード	コード	シナリオ説明	解決策
200	200	リクエスト成功
200	0	現在のバージョンが最新です
400	400001	無効なリクエスト
400	400002	パラメータが不足しています
400	400003	無効なパラメータ
400	400004	無効なヘッダー
400	400005	無効なリクエストボディ
401	401001	認証に失敗しました
401	401002	署名検証に失敗しました
404	404001	リソースが見つかりません
404	404002	レコードが見つかりません
404	404003	処理方法が見つかりません
404	404004	リクエストが見つかりません
500	500001	サーバー内部エラー	お問い合わせください お問い合わせ
500	500002	サーバー内部データ検証に失敗しました	お問い合わせください お問い合わせ