File Application - Get Upgrade Strategy

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

📮Request Information

Request URL

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

Request Headers

Parameter Name	Required	Type	Example	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	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 Nonce value already exists (to prevent duplicate requests)

Request Body

{
    "fileKey": "LOYlLXNy7wV3ySuh0XgtSg",
    "versionCode": 1,
    "appointVersionCode": 0,
    "devModelKey": "stv1",
    "devKey": "LOYlLXNy7w"
}

Request Body Parameter Description

Parameter Name	Required	Type	Example	Description
fileKey	Yes	string	LOYlLXNy7wV3ySuh0XgtSg	Unique identifier for file application
versionCode	Yes	int	1	Version code recorded in the system
appointVersionCode	No	int	0	Expected upgrade version code, leave empty or 0 to request the latest version
devModelKey	No	string	stv1	Unique identifier for device model
devKey	No	string	LOYlLXNy7w	Unique device identifier (can use MAC address as unique identifier)

📮Response Information

Successful Response Body

{
  "code": 200,
  "msg": "New version found",
  "data": {
    "fileKey": "LOYlLXNy7wV3ySuh0XgtSg",
    "versionName": "v2",
    "versionCode": 2,
    "urlPath": "http://file.com/2.exe",
    "upgradeType": 1,
    "promptUpgradeContent": "Prompt content"
  }
}

Response Body Parameter Description

Parameter Name	Type	Example	Description
fileKey	string	LOYlLXNy7wV3ySuh0XgtSg	Unique identifier for file application
versionName	string	v1	Version name
versionCode	int	1	Version code
urlPath	string	http://file.com/2.exe	File download URL
upgradeType	int	1	Upgrade type: 1: Prompt upgrade; 2: Silent upgrade; 3: Forced upgrade
promptUpgradeContent	string	Prompt content	Prompt upgrade description

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/file/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, upgrade strategy obtained
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
429	429001	Application task strategy request rate limit exceeded	The request rate limit configured for the upgrade task has been reached. Please try again later.
500	500001	Internal server error	Please contact us Contact Us
500	500002	Internal server data validation failed	Please contact us Contact Us