License API
Installation File

5min
This endpoint provides the informations about product installation file for some license
GET
Request
Query Parameters
product
required
String
Product short code
hardware_id
required
String
Unique hardware ID generated for some device
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. [email protected])
license_id
optional
String
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
version
optional
String
Version string, eq. 1.0.0
env
optional
String
Version of environment eq. "win", "win32", "win64", "mac", "linux", "linux32", "linux64"
channel
optional
String
Channel of a version, eq. staging or prod.
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/installation_file?product=string&hardware_id=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/installation_file?product=string&hardware_id=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Responses
200
{
    "installation_file": "https://www.test.io/file/file.bin",
    "version": "1.0.2",
    "requires_version": null,
    "hash_md5": "",
    "release_date": "2021-04-30T00:00:00.000Z"
}
{
    "installation_file": "https://www.test.io/file/file.bin",
    "version": "1.0.2",
    "requires_version": null,
    "hash_md5": "",
    "release_date": "2021-04-30T00:00:00.000Z"
}
﻿
Product versions are returned up to the existing maintenance_period OR validity_period on the license. If those fields are not defined on a license, all versions will be returned by default.
List of exceptions
company.sdk_allow_inactive_get_files === true
license_key_or_license_user_required (400): The license_key or license user is missing
active_license_required (400): An active license is required
missing_headers (400): Some headers are missing
missing_parameters (400): Some parameters are missing in the request: { params }
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
device_not_found (400): An active device matching the hardware_id not found
﻿
Updated 25 Sep 2024
Did this page help you?
Versions
Customer License Users