Windows Application Version Details

API Description: Based on the client's version number, retrieve the corresponding version details

📮Request Information

Request URL

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

Request Headers

Parameter Name	Required	Type	Example Value	Description
X-Timestamp	Yes	string	2025-02-17T10:34:55+08:00	Request time in RFC3339 format
X-Nonce	Yes	string	fc812cc0b9b51e8c	Unique random string (at least 16 characters)
X-AccessKey	Yes	string	mui2W50H1j-OC4xD6PgQag	Secret key AccessKey
X-Signature	Yes	string	3603437250c2df51fc46426ac79d8995	Request signature Signature Rules
Content-Type	Yes	string	application/json

🔐 Anti-Replay Attack Mechanism

1. Server verifies that the timestamp difference with server time does not exceed ±5 minutes
2. Server checks if the Nonce value already exists (to prevent duplicate requests)

Request Body

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

Request Body Parameters

Parameter Name	Required	Type	Example Value	Description
winKey	Yes	string	isVZBUvkFhv6oHxk_X-D0Q	Windows application unique identifier
versionCode	Yes	int	1	Client version code
arch	Yes	string	x64	Machine architecture: x64, arm64

📮Response Information

Success Response Body

{
  "code": 200,
  "msg": "Version details found",
  "data": {
    "winKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "packageName": "com.a.c",
    "versionName": "v2",
    "versionCode": 2,
    "description": "Description content",
    "pubDate": "2024-02-17T10:34:55+08:00",
    "arch": "x64",
    "releaseNote": "Release note content",
    "changelog": "Changelog content",
    "upgradeMode": 1,
    "forcedUpgradeVersionCode": 1,
    "silentUpgradeVersionCode": 1,
    "target": "win",
    "releaseUrl": "https://example.com/windows-app-v2.exe",
    "updateType": "manual",
    "md5": "md5 value",
    "sha256": "sha256 value",
    "downloadUrl": "https://example.com/windows-app-v2.exe",
    "fileSize": 1024000,
    "downloadTimes": 100,
    "isPreRelease": false
  }
}

Response Body Parameters

Parameter Name	Type	Example Value	Description
winKey	string	isVZBUvkFhv6oHxk_X-D0Q	Windows application unique identifier
packageName	string	com.a.c	Windows application package name
versionName	string	v2	Version name
versionCode	int	2	Version code
description	string	Description content	Description content
pubDate	string	2024-02-17T10:34:55+08:00	Publication date
arch	string	x64	Machine architecture
releaseNote	string	Release note content	Release note
changelog	string	Changelog content	Changelog
upgradeMode	int	1	Upgrade mode
forcedUpgradeVersionCode	int	1	Forced upgrade version code
silentUpgradeVersionCode	int	1	Silent upgrade version code
target	string	win	Target platform
releaseUrl	string	https://example.com/windows-app-v2.exe	Release URL
updateType	string	manual	Update type
md5	string	md5 value	MD5 checksum
sha256	string	sha256 value	SHA256 checksum
downloadUrl	string	https://example.com/windows-app-v2.exe	Download URL
fileSize	int	1024000	File size (bytes)
downloadTimes	int	100	Download count
isPreRelease	boolean	false	Is pre-release

Typical Error Response Body

{
  "code": 404001,
  "msg": "No available version found",
  "docs": "No corresponding application version found. Please confirm if it has been correctly created in the system. Please refer to the documentation: http://upgrade.toolsetlink.com/upgrade/recommend/apk/app-version.html",
  "data": null
}

📊Status Codes

HTTP Status Code	code	Scenario Description	Solution
200	200	Version details found
200	0	Current version is latest
400	400001	Invalid request
400	400002	Missing parameters
400	400003	Invalid parameters
400	400004	Invalid headers
400	400005	Invalid request body
401	401001	Authentication failed
401	401002	Signature verification failed
404	404001	Resource not found
404	404002	Record not found
404	404003	Processing method not found
404	404004	Request not found
500	500001	Internal server error	Please contact us Contact Us
500	500002	Internal server data validation failed	Please contact us Contact Us