URL Application Version Details
API Description: Based on the client's version number, obtain the corresponding version details
📮Request Information
Request URL
POST https://api.upgrade.toolsetlink.com/v1/url/version
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 | Secret key - AccessKey |
| X-Signature | Yes | string | 3603437250c2df51fc46426ac79d8995 | Request signature Signature Rules |
| Content-Type | Yes | string | application/json |
🔐 Anti-replay Attack Mechanism
- Server verifies that the timestamp difference with server time does not exceed ±5 minutes
- Server checks if the Nonce value already exists (to prevent duplicate requests)
Request Body
json
{
"urlKey": "LOYlLXNy7wV3ySuh0XgtSg",
"versionCode": 1
}Request Body Parameter Description
| Parameter Name | Required | Type | Example | Description |
|---|---|---|---|---|
| urlKey | Yes | string | LOYlLXNy7wV3ySuh0XgtSg | Unique identifier for URL application |
| versionCode | Yes | int | 1 | Client version code |
📮Response Information
Success Response Body
json
{
"code": 200,
"msg": "Version details found",
"data": {
"urlKey": "LOYlLXNy7wV3ySuh0XgtSg",
"versionName": "v2",
"versionCode": 2,
"description": "Version description"
}
}Response Body Parameter Description
| Parameter Name | Type | Example | Description |
|---|---|---|---|
| urlKey | string | LOYlLXNy7wV3ySuh0XgtSg | Unique identifier for URL application |
| versionName | string | v1 | Version name |
| versionCode | int | 1 | Version code |
| description | string | Version description | Version description content |
Typical Error Response Body
json
{
"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: https://upgrade.toolsetlink.com/en/upgrade/recommend/apk/app-version.html",
"data": null
}📊Status Codes
| HTTP Status Code | code | Scenario Description | Solution |
|---|---|---|---|
| 200 | 200 | Request successful | |
| 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 |