Android Application Get Upgrade Strategy

Interface Description: Get the corresponding upgrade strategy based on the client's version number.

📮 Request Information

Request URL

POST https://api.upgrade.toolsetlink.com/v1/apk/upgrade

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	Access Key
X-Signature	Yes	string	3603437250c2df51fc46426ac79d8995	Request signature Signature Rules
Content-Type	Yes	string	application/json

🔐 Replay Attack Prevention Mechanism

1. Server validates timestamp difference with server time not exceeding ±5 minutes
2. Server checks if Nonce value already exists (prevents duplicate requests)

Request Body

{
    "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "versionCode": 1,
    "appointVersionCode": 0,
    "devModelKey": "stv1",
    "devKey": "LOYlLXNy7w"
}

Request Body Parameter Description

Parameter Name	Required	Type	Example Value	Description
apkKey	Yes	string	isVZBUvkFhv6oHxk_X-D0Q	Android Application Unique Identifier
versionCode	Yes	int	1	Client Version Number
appointVersionCode	No	int	0	Expected upgrade version number, defaults to latest version if not provided or set to 0
devModelKey	No	string	stv1	Device Model Unique Identifier
devKey	No	string	LOYlLXNy7w	Device Unique Identifier (can use mac as unique identifier)

📮 Response Information

Success Response Body

{
  "code": 200,
  "msg": "New version obtained",
  "data": {
    "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "packageName": "com.a.c",
    "versionName": "v2",
    "versionCode": 2,
    "urlPath": "https://cdn.upgrade.toolsetlink.com/upgrade/2025-07-02/image/20250702102511_dl-logo-48x.png",
    "urlFileSize": 7213,
    "urlFileMd5": "",
    "upgradeType": 1,
    "promptUpgradeContent": "Prompt content"
  }
}

Response Body Parameter Description

Parameter Name	Type	Example Value	Description
apkKey	string	isVZBUvkFhv6oHxk_X-D0Q	Android Application Unique Identifier
packageName	string	com.a.c	Android Application Package Name
versionName	string	v1	Version Name
versionCode	int	1	Version Number
urlPath	string	http://file.com/2.apk	File Download URL
urlFileSize	int	7213	File Size (bytes)
urlFileMd5	string	isVZBUvkFhv6oHxk	File MD5
upgradeType	int	1	Upgrade Method: 1: Prompt upgrade; 2: Silent upgrade; 3: Force upgrade
promptUpgradeContent	string	Prompt content	Upgrade description content

Typical Error Response Body

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

📊 Status Codes

HTTP Status Code	Code	Scenario Description	Solution
200	0	Request successful, already at latest version
200	200	Request successful, obtained version upgrade strategy
400	400001	Illegal 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 does not exist
404	404002	Query record does not exist
404	404003	Processing method does not exist
404	404004	Request does not exist
429	429001	Application task strategy request rate limit	Current upgrade task configuration request rate limit has been reached, please try again later.
500	500001	Server internal error	Contact us Contact Us
500	500002	Server internal data validation failed	Contact us Contact Us