Distributing Releases
Downloading a release
In order to download the release, the release URL must contain license key as key
query parameter or access token
in the header.
The license key must belong to the product for which the release was created and the access token must belong to any user who is associated with the license key of the product.
The external release files are not secured and hence don't requirekey
query parameter for download.
Downloading an update
In order to detect whether an update is available for your product, you can either invoke the /v3/releases/update Web API endpoint or use CheckReleaseUpdate()
LexActivator function.
Using Web API
The following sample request checks whether a new release is available by comparing it with the provided release version.
Check for an update
GET
https://api.cryptlex.com/v3/releases/update
Query Parameters
productId*
string
Unique identifier for the product
platform*
string
Release platform
channel
string
Release channel (defaults to "stable")
version*
string
Current release version
key*
string
License key
accountId*
string
Unique identifier for the account
If an update is available it returns a 200
success response containing the download URL, else it will return a 204
empty response.
Using LexActivator
The sample code for checking the release update is available on GitHub for all the languages in their sample files. The following sample code demonstrates it for C/C++.
Ignoring PATCH and BUILD updates
The version format syntax in Cryptlex is $MAJOR.$MINOR.$PATCH.$BUILD
. In case you want to ignore $PATCH
and $BUILD
releases in the update API endpoint you can pass the partial version too.
The following table summarises the expected response by the /v3/releases/update
API endpoint if it is invoked with version
query param set to the values in the first column:
Version (Query Param)
Latest Version
Response (Status Code)
1.2.3.5
1.2.3.5
204
1.2.3.4
1.2.3.5
200
1.2.3
1.2.3.4
204
1.2
1.2.3.4
204
Suppose your latest release version is 1.2.3.4
and you invoke the update API endpoint with version
query param having a value 1.2.3
, then it will return 204
status code indicating no update.
Downloading latest
In order to download the latest release of your product, you need to invoke the /v3/releases/latest endpoint to get the download URLs for the latest release.
The following sample request fetches the latest release details.
Download latest release
GET
https://api.cryptlex.com/v3/releases/latest
Query Parameters
productId*
string
Unique identifier for the product
platform*
string
Release platform
channel
string
Release channel (defaults to "stable")
key*
string
License key
accountId
string
Unique identifier for the account
It returns a 200
success response containing the download URLs of the latest release.
Last updated