Electron Application Get Version Details
Interface Description: Get corresponding version details based on client version number
📮 Request Information
Request Address
POST https://api.upgrade.toolsetlink.com/v1/electron/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 | Access Key |
| X-Signature | Yes | string | 3603437250c2df51fc46426ac79d8995 | Request signature Signature Rules |
| Content-Type | Yes | string | application/json |
🔐 Replay Attack Prevention Mechanism
- Server validates timestamp difference with server time not exceeding ±5 minutes
- Server checks if Nonce value already exists (prevents duplicate requests)
Request Body
json
{
"electronKey": "isVZBUvkFhv6oHxk_X-D0Q",
"versionCode": 1,
"platform": "linux",
"arch": "x86_64"
}Request Body Parameter Description
| Parameter Name | Required | Type | Example Value | Description |
|---|---|---|---|---|
| electronKey | Yes | string | isVZBUvkFhv6oHxk_X-D0Q | Electron application unique identifier |
| versionName | Yes | string | 1.0.0 | Client version number |
| platform | Yes | string | linux | Operating system: linux, darwin, windows |
| arch | Yes | string | x64 | Machine architecture: x64, arm64 |
📮 Response Information
Success Response Body
json
{
"code": 200,
"msg": "New version obtained",
"data": {
"electronKey": "isVZBUvkFhv6oHxk_X-D0Q",
"versionName": "v2",
"versionCode": 2,
"platform": "linux",
"arch": "x64",
"description": "Description content"
}
}Response Body Parameter Description
| Parameter Name | Type | Example Value | Description |
|---|---|---|---|
| electronKey | string | isVZBUvkFhv6oHxk_X-D0Q | Electron application unique identifier |
| versionName | string | v1 | Version name |
| versionCode | int | 1 | Version number |
| description | string | Description content | Description content |
Typical Error Response Body
json
{
"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 | 200 | Request successful | |
| 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 not found | |
| 404 | 404002 | Query record not found | |
| 404 | 404003 | Processing method not found | |
| 404 | 404004 | Request not found | |
| 500 | 500001 | Server internal error | Contact us Contact Us |
| 500 | 500002 | Server internal data validation failed | Contact us Contact Us |