Android App Get Version Details

API Description: Based on the client's version number, get the corresponding version details

📮Request Information

Request URL

POST https://api.upgrade.toolsetlink.com/v1/apk/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

1. The server verifies that the timestamp difference with the server time does not exceed ±5 minutes
2. The server checks if the Nonce value already exists (to prevent duplicate requests)

Request Body

{
    "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "versionCode": 1
}

Request Body Parameters

Parameter Name	Required	Type	Example Value	Description
apkKey	Yes	string	isVZBUvkFhv6oHxk_X-D0Q	Unique identifier for Android app
versionCode	Yes	int	1	Client version code

📮Response Information

Success Response

{
  "code": 200,
  "msg": "New version found",
  "data": {
    "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "packageName": "com.a.c",
    "versionName": "v2",
    "versionCode": 2,
    "description": "Description content"
  }
}

Response Body Parameters

Parameter Name	Type	Example Value	Description
apkKey	string	isVZBUvkFhv6oHxk_X-D0Q	Unique identifier for Android app
packageName	string	com.a.c	Android app package name
versionName	string	v1	Version name
versionCode	int	1	Version code
description	string	Description content	Description content

Typical Error Response

{
  "code": 404001,
  "msg": "No available version found",
  "docs": "No corresponding app version found. Please confirm if it has been correctly created in the system. Please refer to the 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	Invalid request
400	400002	Missing parameters
400	400003	Invalid parameters
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	Internal server error	Contact us Contact Us
500	500002	Internal server data validation failed	Contact us Contact Us