Configuration - Get Version Information
API Description: Based on the client's version number, retrieve the corresponding version information
📮 Request Information
Request URL
POST https://api.upgrade.toolsetlink.com/v1/configuration/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
- The server verifies that the timestamp differs from the server time by no more than ±5 minutes
- The server checks if the Nonce value already exists (to prevent duplicate requests)
Request Body
json
{
"configurationKey": "q1hfB1VUQaK9VksTZGPU1Q",
"versionCode": 1
}Request Body Parameters
| Parameter Name | Required | Type | Example Value | Description |
|---|---|---|---|---|
| configurationKey | Yes | string | q1hfB1VUQaK9VksTZGPU1Q | Unique configuration identifier |
| versionCode | Yes | int | 1 | Version code registered in the system |
📮 Response Information
Successful Response Body
json
{
"code": 200,
"msg": "New version obtained",
"data": {
"configurationKey": "q1hfB1VUQaK9VksTZGPU1Q",
"versionName": "v2",
"versionCode": 2,
"description": "Description content"
}
}Response Body Parameters
| Parameter Name | Type | Example Value | Description |
|---|---|---|---|
| configurationKey | string | q1hfB1VUQaK9VksTZGPU1Q | Unique configuration identifier |
| versionName | string | v1 | Version name |
| versionCode | int | 1 | Version code |
| description | string | Description content | Description content |
Typical Error Response Body
json
{
"code": 404001,
"msg": "No available version obtained",
"docs": "No corresponding application version found, please confirm whether it has been correctly created in the system. Please refer to the documentation: http://upgrade.toolsetlink.com/upgrade/recommend/url/app-version.html",
"data": null
}📊 Status Codes
| HTTP Status Code | Code | Scenario Description | Solution |
|---|---|---|---|
| 200 | 200 | Request successful | |
| 400 | 400001 | Invalid request | |
| 400 | 400002 | Parameter missing | |
| 400 | 400003 | Invalid parameter | |
| 400 | 400004 | Invalid header | |
| 400 | 400005 | Invalid 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 | Server internal error | Please contact us Contact Us |
| 500 | 500002 | Server internal data verification failed | Please contact us Contact Us |