LicenseSpring

https://docs.licensespring.com/
Admin
LicenseSpring simplifies software licensing with comprehensive documentation, offering streamlined...
Tokens:488,384
Snippets:3,731
Trust Score:8.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation File Response Example

Source: https://docs.licensespring.com/license-api/get-installation-file

A sample JSON response returned by the installation file endpoint.

```json
{
    "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",
    "eula_link": null,
    "release_notes_link": null,
    "size": null,
    "channel": null
}
```

--------------------------------

### Create Installation File Data Example

Source: https://docs.licensespring.com/management-api/product/installation-files/create-installation-file

Use this JSON structure to send a POST request to create a new installation file. Ensure all required fields are populated.

```json
{
    "product": 1586066454419502,
    "version": "1.0.4",
    "full_link": "https://example.com/installation_file_3.zip",
    "filename": "my_filename",
    "release_date": "2024-04-05",
    "enabled": 1,
    "hash_md5": "aaaaaaaaaaaaaaaaaaaaaaaa",
    "environment": "linux64",
    "size": "600",
    "eula_link": "",
    "release_notes_link": "",
    "requires_version": "",
    "channel": "ch1"
}
```

--------------------------------

### List Installation Files - Success Response Example

Source: https://docs.licensespring.com/management-api/product/installation-files/list-installation-files

This JSON structure represents a successful response when listing installation files. It includes pagination details and a list of installation file objects.

```json
{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 733508,
            "created_at": "2023-04-19T08:23:00Z",
            "updated_at": "2023-04-19T08:27:32Z",
            "version": "1.0.4",
            "full_link": "https://example.com/installation_file_4.zip",
            "filename": "installation_file_4.zip",
            "release_date": "2023-04-05",
            "enabled": true,
            "hash_md5": "aaaaaaaaaaaaaaaaaaaaaaaa",
            "environment": "linux64",
            "release_notes_link": "",
            "eula_link": "",
            "size": "600",
            "requires_version": "1.0.3",
            "channel": "",
            "product": 1586066454419502
        },
        ...
    ]
}
```

--------------------------------

### Installation File Creation Success Response

Source: https://docs.licensespring.com/management-api/product/installation-files/create-installation-file

This is an example of a successful response after creating an installation file. It includes the newly created resource's details.

```json
{
    "id": 733516,
    "created_at": "2023-07-03T12:21:55.934397Z",
    "updated_at": "2023-07-03T12:21:55.934476Z",
    "version": "1.0.4",
    "full_link": "https://example.com/installation_file_3.zip",
    "filename": "installation_file_3.zip",
    "release_date": "2024-04-05",
    "enabled": true,
    "hash_md5": "aaaaaaaaaaaaaaaaaaaaaaaa",
    "environment": "linux64",
    "release_notes_link": "",
    "eula_link": "",
    "size": "600",
    "requires_version": "1.0.4",
    "channel": "ch1",
    "product": 1586066454419502
}
```

--------------------------------

### Retrieve Installation File Metadata

Source: https://docs.licensespring.com/license-api/get-installation-file

Examples for requesting installation file information using various programming languages and tools.

```bash
curl --location --request GET '/api/v4/installation_file?product=string&hardware_id=string&license_key=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
```

```javascript
var request = require('request');
var options = {
  method: 'GET',
  url: '/api/v4/installation_file?product=string&hardware_id=string&license_key=string',
  headers: {
    'Accept': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("/api/v4/installation_file?product=string&hardware_id=string&license_key=string", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```python
import requests

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

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

response = requests.get(url, headers=headers)
print(response.text)
```

```ruby
require "uri"
require "net/http"

url = URI("/api/v4/installation_file?product=string&hardware_id=string&license_key=string")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Get installation file

Source: https://docs.licensespring.com/sdks/python-sdk/api-client-usage-examples

Fetches the latest installation file, with optional filters for environment or version.

```python
product = "lkprod1"
license_key = "GPB7-279T-6MNK-CQLK"

# Get the latest installation file
installation_file_data = api_client.installation_file(
    product=product, license_key=license_key
)

# Get the latest installation file for linux environment
installation_file_data = api_client.installation_file(
    product=product, license_key=license_key, env="linux"
)

# Get the latest installation file for version 1.0.0
installation_file_data = api_client.installation_file(
    product=product, license_key=license_key, version="1.0.0"
)

print(installation_file_data)
```

--------------------------------

### Get Product Installation File

Source: https://docs.licensespring.com/sdks/node.js-sdk/bundle-manager

Retrieves details for a specific product installation file.

```typescript
getInstallationFile(payload: GetInstallationFilePayload): Promise<InstallationFileResponse>

type GetInstallationFilePayload = ({
    license_key: string;
} | {
    username: string;
}) & {
    sdk_ver: string | undefined;
    env: string | undefined;
    channel: string | undefined;
    version: string | undefined;
};

type InstallationFileResponse = {
  id: number;
  version: string | undefined;
  installation_file: string | undefined;
  release_date: string | null;
  hash_md5: string | undefined;
  environment: string;
  eula_link: string | undefined;
  release_notes_link: string | undefined;
  size: string | undefined;
  requires_version: string | undefined;
  channel: string | undefined;
  company: {
    id: number;
  };
};
```

--------------------------------

### Get Product Installation File

Source: https://docs.licensespring.com/sdks/node.js-sdk/bundle-manager

Retrieves the installation file for a specific product version.

```APIDOC
## GET /api/products/installation-file

### Description
Retrieves the installation file for a specific product version.

### Method
GET

### Endpoint
/api/products/installation-file

### Parameters
#### Query Parameters
- **sdk_ver** (string) - Optional - The SDK version.
- **env** (string) - Optional - The environment (e.g., 'production', 'staging').
- **channel** (string) - Optional - The distribution channel.
- **version** (string) - Optional - The specific product version.

#### Request Body
- **license_key** (string) - Required - The license key for the product.
OR
- **username** (string) - Required - The username associated with the product.

### Request Example
```json
{
  "license_key": "YOUR_LICENSE_KEY",
  "version": "1.2.0",
  "sdk_ver": "1.0.0",
  "env": "production",
  "channel": "stable"
}
```
OR
```json
{
  "username": "user@example.com",
  "version": "1.2.0",
  "sdk_ver": "1.0.0",
  "env": "production",
  "channel": "stable"
}
```

### Response
#### Success Response (200)
- **id** (number) - The unique identifier for the installation file.
- **version** (string | undefined) - The version of the product.
- **installation_file** (string | undefined) - The content or URL of the installation file.
- **release_date** (string | null) - The release date of the version.
- **hash_md5** (string | undefined) - The MD5 hash of the installation file.
- **environment** (string) - The environment for which the file is intended.
- **eula_link** (string | undefined) - Link to the End User License Agreement.
- **release_notes_link** (string | undefined) - Link to the release notes.
- **size** (string | undefined) - The size of the installation file.
- **requires_version** (string | undefined) - The minimum required version for this file.
- **channel** (string | undefined) - The distribution channel.
- **company** (object) - Information about the company.
  - **id** (number) - The company's unique identifier.
```

--------------------------------

### Install LicenseSpring Go SDK

Source: https://docs.licensespring.com/sdks/go-sdk

Use the go get command to fetch the latest version of the SDK from the repository.

```bash
go get -u gitlab.com/l3178/sdk-go/...
```

--------------------------------

### Get Product Installation File

Source: https://docs.licensespring.com/sdks/node.js-sdk/license-api

Fetches the installation file for a specific product version. Requires product and hardware ID, and can be authenticated with a license key or username. Optional parameters include environment, channel, and version.

```typescript
getInstallationFile(payload: GetInstallationFilePayload): Promise<InstallationFileResponse>

type GetInstallationFilePayload = ({
    license_key: string;
} | {
    username: string;
}) & {
    product: string;
    hardware_id: string;
    sdk_ver: string | undefined;
    env: string | undefined;
    channel: string | undefined;
    version: string | undefined;
};

type InstallationFileResponse = {
  id: number;
  version: string | undefined;
  installation_file: string | undefined;
  release_date: string | null;
  hash_md5: string | undefined;
  environment: string;
  eula_link: string | undefined;
  release_notes_link: string | undefined;
  size: string | undefined;
  requires_version: string | undefined;
  channel: string | undefined;
  company: {
    id: number;
  };
};
```

--------------------------------

### Pagination Examples

Source: https://docs.licensespring.com/management-api/analytics/hourly-activities/list-hourly-activities-actions-stats

Examples of query parameters used to control the number of results and the starting index.

```text
limit=20
```

```text
offset=21
```

--------------------------------

### Check Bundle Request Examples

Source: https://docs.licensespring.com/license-api/license-check/check-bundle

Examples of how to perform a GET request to the check_bundle endpoint using various programming languages and tools.

```bash
curl --location --request GET '/api/v4/check_bundle?hardware_id=string&product=string&license_key=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
```

```javascript
var request = require('request');
var options = {
  method: 'GET',
  url: '/api/v4/check_bundle?hardware_id=string&product=string&license_key=string',
  headers: {
    'Accept': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("/api/v4/check_bundle?hardware_id=string&product=string&license_key=string", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```python
import requests

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

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

response = requests.get(url, headers=headers)
print(response.text)
```

```ruby
require "uri"
require "net/http"

url = URI("/api/v4/check_bundle?hardware_id=string&product=string&license_key=string")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body
```

--------------------------------

### First-Time Admin Setup - Setting Initial Password

Source: https://docs.licensespring.com/floating-server/floating-server-v2/running-and-administration

Guides users through setting the initial administrator password for the Floating Server, either via the UI or API.

```APIDOC
## First-Time Admin Setup

When the server starts for the first time, no users or admins exist. You must set the initial **admin password**.

* **Default username:** `admin`
* **Password:** defined during setup.

### Setting the Password

You can set the initial admin password via the UI or the API.

#### Via API

**Method:** `POST`
**Endpoint:** `/api/v5/auth/initial-password`

**Request Body:**
```json
{
  "password": "string"
}
```

**Responses:**
* **200 OK:** Password set successfully, returns a JWT token.
* **400 Bad Request:** Invalid input.
* **401 Unauthorized:** Authentication failed.

#### Via UI

Navigate to the Floating Server’s URL. You’ll be redirected to the password setup page.
```

--------------------------------

### List Products API Requests

Source: https://docs.licensespring.com/license-api/products/list-products

Examples of how to perform a GET request to the products endpoint using various HTTP clients.

```bash
curl --location --request GET '/api/v4/products' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
```

```javascript
var request = require('request');
var options = {
  method: 'GET',
  url: '/api/v4/products',
  headers: {
    'Accept': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("/api/v4/products", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```python
import requests

url = "/api/v4/products"

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

response = requests.get(url, headers=headers)
print(response.text)
```

```ruby
require "uri"
require "net/http"

url = URI("/api/v4/products")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Retrieve Product Success Response

Source: https://docs.licensespring.com/management-api/product/list-products

Example of a successful 200 OK JSON response containing product details, features, and installation files.

```json
{
    "count": 6,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1584723961091234,
            "upgrade_from": [],
            "product_features": [
                {
                    "id": 171,
                    "created_at": "2020-08-26T05:36:46Z",
                    "updated_at": "2020-08-26T05:36:46Z",
                    "name": "Feature 1",
                    "code": "f1",
                    "is_deleted": false,
                    "feature_type": "activation",
                    "max_consumption": 0,
                    "allow_overages": false,
                    "max_overages": 0,
                    "reset_consumption": false,
                    "consumption_period": null
                },
                {
                    "id": 172,
                    "created_at": "2020-08-26T05:37:14Z",
                    "updated_at": "2020-08-26T05:37:14Z",
                    "name": "Feature 2",
                    "code": "f2",
                    "is_deleted": false,
                    "feature_type": "consumption",
                    "max_consumption": 20,
                    "allow_overages": false,
                    "max_overages": 0,
                    "reset_consumption": false,
                    "consumption_period": null,
                    "metadata": {},
                },
                {
                    "id": 173,
                    "created_at": "2020-09-14T11:17:43Z",
                    "updated_at": "2020-09-14T11:17:43Z",
                    "name": "Feature 3",
                    "code": "f3",
                    "is_deleted": false,
                    "feature_type": "consumption",
                    "max_consumption": 2,
                    "allow_overages": false,
                    "max_overages": 0,
                    "reset_consumption": false,
                    "consumption_period": null,
                    "metadata": {},
                },
                {
                    "id": 189,
                    "created_at": "2020-11-13T07:40:53Z",
                    "updated_at": "2020-11-13T07:40:53Z",
                    "name": "Feature 5",
                    "code": "f5",
                    "is_deleted": false,
                    "feature_type": "activation",
                    "max_consumption": 0,
                    "allow_overages": false,
                    "max_overages": 0,
                    "reset_consumption": false,
                    "consumption_period": null,
                    "metadata": {},
                }
            ],
            "custom_fields": [
                {
                    "id": 51,
                    "name": "Some key",
                    "data_type": null,
                    "default_value": "1234",
                    "description": null
                },
                {
                    "id": 60,
                    "name": "test_name",
                    "data_type": null,
                    "default_value": "123",
                    "description": null
                },
                {
                    "id": 61,
                    "name": "Key with space",
                    "data_type": null,
                    "default_value": "123",
                    "description": null
                }
            ],
            "installation_files": [
                {
                    "id": 733282,
                    "created_at": "2020-10-13T09:15:22Z",
                    "updated_at": "2020-10-13T09:15:22Z",
                    "version": "0.1",
                    "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
                    "filename": "dummy.pdf",
                    "release_date": "2020-10-09",
                    "enabled": true,
                    "hash_md5": "",
                    "environment": "linux"
                },
                {
                    "id": 733283,
                    "created_at": "2020-10-13T09:15:52Z",
                    "updated_at": "2020-10-13T09:15:52Z",
                    "version": "0.2",
                    "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
                    "filename": "dummy.pdf",
                    "release_date": "2020-10-10",
                    "enabled": true,
                    "hash_md5": "sonotahash",
                    "environment": "linux"
                }
            ],
            "created_at": "2020-07-03T13:05:25Z",
            "updated_at": "2020-07-07T12:35:05Z",
            "product_name": "mch",
            "short_code": "mch",
            "active": true,
            "valid_duration": "",
            "allow_trial": false,
            "trial_days": 0,
            "max_activations": 1,
            "hardware_id_required": false,
            "is_upgrade": false
```

--------------------------------

### Installation Files API

Source: https://docs.licensespring.com/management-api

Endpoints for managing installation files for products.

```APIDOC
## GET /api/products/installation-files

### Description
Lists all installation files associated with products.

### Method
GET

### Endpoint
/api/products/installation-files

### Response
#### Success Response (200)
- **files** (array) - A list of installation file objects.
  - **id** (string) - The unique identifier of the installation file.
  - **name** (string) - The name of the installation file.
  - **version** (string) - The version of the installation file.

#### Response Example
```json
{
  "files": [
    {
      "id": "if_abc",
      "name": "Installer v1.0",
      "version": "1.0.0"
    }
  ]
}
```
```

```APIDOC
## GET /api/products/installation-files/{id}

### Description
Retrieves a specific installation file by its ID.

### Method
GET

### Endpoint
/api/products/installation-files/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the installation file to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the installation file.
- **name** (string) - The name of the installation file.
- **version** (string) - The version of the installation file.
- **url** (string) - The download URL for the installation file.

#### Response Example
```json
{
  "id": "if_abc",
  "name": "Installer v1.0",
  "version": "1.0.0",
  "url": "http://example.com/installers/installer_v1.0.zip"
}
```
```

```APIDOC
## POST /api/products/installation-files

### Description
Uploads a new installation file.

### Method
POST

### Endpoint
/api/products/installation-files

### Parameters
#### Request Body
- **name** (string) - Required - The name of the installation file.
- **version** (string) - Required - The version of the installation file.
- **file** (file) - Required - The installation file to upload.

### Request Example
(This endpoint typically involves multipart/form-data for file uploads)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the uploaded installation file.
- **name** (string) - The name of the installation file.
- **version** (string) - The version of the installation file.

#### Response Example
```json
{
  "id": "if_new",
  "name": "NewInstaller v1.1",
  "version": "1.1.0"
}
```
```

```APIDOC
## PUT /api/products/installation-files/{id}

### Description
Updates an existing installation file.

### Method
PUT

### Endpoint
/api/products/installation-files/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the installation file to update.

#### Request Body
- **name** (string) - Optional - The new name of the installation file.
- **version** (string) - Optional - The new version of the installation file.
- **file** (file) - Optional - The new installation file to upload.

### Request Example
(This endpoint typically involves multipart/form-data for file uploads)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the updated installation file.
- **name** (string) - The name of the installation file.
- **version** (string) - The version of the installation file.

#### Response Example
```json
{
  "id": "if_abc",
  "name": "Installer v1.0 Updated",
  "version": "1.0.1"
}
```
```

```APIDOC
## DELETE /api/products/installation-files/{id}

### Description
Deletes an installation file.

### Method
DELETE

### Endpoint
/api/products/installation-files/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the installation file to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of deletion.

#### Response Example
```json
{
  "message": "Installation file deleted successfully."
}
```
```

--------------------------------

### List Installation Files

Source: https://docs.licensespring.com/management-api/product/installation-files/list-installation-files

Retrieves a list of installation files with support for pagination and filtering.

```APIDOC
## GET /api/v1/installation-files/

### Description
Retrieves a list of installation files. Supports pagination and filtering by product.

### Method
GET

### Endpoint
/api/v1/installation-files/

### Query Parameters
#### Pagination
* `limit` (integer) - Optional - Number of results to return per page. Defaults to 20.
  * Example: `limit=20`
* `offset` (integer) - Optional - The initial index from which to return the results. 
  * Example: `offset=21`

#### Filtering
* `product` (integer) - Optional - Filters results by product ID.

### Response
#### Success Response (200 OK)
- `count` (integer) - Total number of results.
- `next` (string) - URL for the next page of results, or null if none.
- `previous` (string) - URL for the previous page of results, or null if none.
- `results` (array) - An array of installation file objects.
  - `id` (integer) - Unique identifier for the installation file.
  - `created_at` (string) - Timestamp when the installation file was created.
  - `updated_at` (string) - Timestamp when the installation file was last updated.
  - `version` (string) - The version number of the installation file.
  - `full_link` (string) - The direct download URL for the installation file.
  - `filename` (string) - The name of the installation file.
  - `release_date` (string) - The date the installation file was released.
  - `enabled` (boolean) - Indicates if the installation file is enabled.
  - `hash_md5` (string) - The MD5 hash of the installation file.
  - `environment` (string) - The target environment for the installation file (e.g., 'linux64').
  - `release_notes_link` (string) - URL to the release notes.
  - `eula_link` (string) - URL to the End User License Agreement.
  - `size` (string) - The size of the installation file.
  - `requires_version` (string) - The minimum version required to use this installation file.
  - `channel` (string) - The release channel (e.g., 'stable', 'beta').
  - `product` (integer) - The ID of the product this installation file belongs to.

#### Response Example
```json
{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 733508,
            "created_at": "2023-04-19T08:23:00Z",
            "updated_at": "2023-04-19T08:27:32Z",
            "version": "1.0.4",
            "full_link": "https://example.com/installation_file_4.zip",
            "filename": "installation_file_4.zip",
            "release_date": "2023-04-05",
            "enabled": true,
            "hash_md5": "aaaaaaaaaaaaaaaaaaaaaaaa",
            "environment": "linux64",
            "release_notes_link": "",
            "eula_link": "",
            "size": "600",
            "requires_version": "1.0.3",
            "channel": "",
            "product": 1586066454419502
        }
    ]
}
```
```

--------------------------------

### Example Response Body for Get Product Versions

Source: https://docs.licensespring.com/license-api/get-product-versions

This is an example of the JSON response body returned by the Get Product Versions API endpoint, showing version and release date information.

```typescript
type GetProductVersionsResponseBody = ({
  version: string,
  release_date: string, // Date string in full ISO 8601 format, e.g. "2024-09-27T23:30:48.016Z"
});[]
```

--------------------------------

### Minimal Setup with Defaults (LicenseHandler)

Source: https://docs.licensespring.com/sdks/go-sdk/v2/handler

Demonstrates minimal setup for LicenseHandler using API key authentication, default managers, and default file-based storage with encryption. Ensure to replace placeholder values with your actual configuration.

```go
lic_mngr_config := license_manager.LicenseManagerBasicConfiguration{
    OAuth:       false,
    ApiKey:      "your-api-key",
    SharedKey:   "your-shared-key",
    ProductCode: "your-product-code",
    AuthData:    auth.FromKey("LICENSE-KEY"),
}

cfg := license_handler.LicenseHandlerConfig{
    lic_mngr_config,
}

lic_handler, err := license_handler.NewLicenseHandler(cfg)
if err != nil {
    log.Fatal(err)
}
```

--------------------------------

### Get installation file

Source: https://docs.licensespring.com/sdks/python-sdk/licensefile-setup-and-usage

Retrieves the installation file associated with a specific license ID.

```python
manager = LicenseManager(conf)

license_id = LicenseID.from_key("3ZG2-K25B-76VN-WXLK")

response = manager.get_installation_file(license_id=license_id)
```

--------------------------------

### Initialize LicenseManager and Verify License

Source: https://docs.licensespring.com/sdks/tutorials/getting-started/python/python-sdk-configuration

Full example demonstrating SDK configuration, license activation, and both local and online verification steps.

```python
from licensespring.licensefile.config import Configuration
from licensespring.licensefile.license_manager import LicenseID
from licensespring.licensefile.license_manager import LicenseManager

conf = Configuration(product="your_product_key",api_key="your_api_key",
                   shared_key="your_shared_key",file_key=key,file_iv=iv)
     

manager = LicenseManager(conf)

license_id = LicenseID.from_key("your_license_key")

try:
    license = manager.activate_license(license_id)

    license.local_check()

    license.check()
    
except Exception as ex:
    print("LicenseSpring exception encountered:", ex)
```

--------------------------------

### Initialize SDK, Activate, and Check License

Source: https://docs.licensespring.com/sdks/tutorials/getting-started/swift-objective-c/swift-sdk-configuration-and-usage

This comprehensive example demonstrates initializing the LicenseManager, activating a new license, and performing both local and full license checks. Error handling is included.

```swift
do {
    let configuration = Configuration(
        apiKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        sharedKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        productCode: "XX"
    )
    configuration.appName = "My LicenseSpring Application"
    configuration.appVersion = "1.0.0"
    
    let manager = try LicenseManager(configuration: configuration)
    let license = try manager.activateLicense(licenseKey: "XXXX-XXXX-XXXX-XXXX")
    try license.localCheck()
    try license.fullCheck()
} catch {
    print("Error occured: \(error)")
}
```

--------------------------------

### Full Code Sample

Source: https://docs.licensespring.com/sdks/tutorials/getting-started/python/python-sdk-configuration

A comprehensive example demonstrating SDK initialization, license activation, and performing both local and online license checks.

```APIDOC
## Full Code Sample

### Description
Initializes the LicenseSpring SDK, retrieves or activates a local license, and performs both local and online checks to ensure license validity and integrity.

### Method
Not applicable (this is a client-side SDK example).

### Endpoint
Not applicable.

### Parameters
Requires configuration details such as `product`, `api_key`, `shared_key`, `file_key`, `file_iv`, and `license_key`.

### Request Example
```python
from licensespring.licensefile.config import Configuration
from licensespring.licensefile.license_manager import LicenseID
from licensespring.licensefile.license_manager import LicenseManager

conf = Configuration(product="your_product_key", api_key="your_api_key",
                   shared_key="your_shared_key", file_key=key, file_iv=iv)

manager = LicenseManager(conf)

license_id = LicenseID.from_key("your_license_key")

try:
    license = manager.activate_license(license_id)
    license.local_check()
    license.check()
except Exception as ex:
    print("LicenseSpring exception encountered:", ex)
```

### Response
#### Success Response (200)
No explicit return value on success for the checks themselves. Exceptions are caught and printed if any occur during the process.

#### Response Example
N/A
```

--------------------------------

### Full LicenseSpring SDK Initialization and Check Example

Source: https://docs.licensespring.com/sdks/tutorials/getting-started/java/java-sdk-configuration-and-usage

A comprehensive example demonstrating how to initialize the LicenseSpring SDK, retrieve or activate a license, and perform both online and local checks. Includes error handling for LicenseSpring exceptions.

```java
LicenseSpringConfiguration configuration = LicenseSpringConfiguration.builder()
                .apiKey("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
                .productCode("javatutorial")
                .sharedKey("XXXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXX")
                .appName("NAME")
                .appVersion("VERSION")
                .build();
                
LicenseManager licenseManager = LicenseManager.getInstance();

try
  {
    licenseManager.initialize(configuration); 

    License currentLicense = licenseManager.getCurrent();
    
    if (currentLicense == null) {
      ActivationLicense key = ActivationLicense.fromKey("XXXX-XXXX-XXXX-XXXX");
      currentLicense = licenseManager.activateLicense(key);
    }
    
    currentLicense = licenseManager.checkLicense(currentLicense);
    currentLicense.localCheck(); // additional check, not needed if you're doing online check, but good for offline mode
  } catch (LicenseSpringException e) {
    System.out.println(e.getCause().getMessage());
  }
```

--------------------------------

### Example Usage of Default Implementations

Source: https://docs.licensespring.com/sdks/go-sdk/v2/handler/storage

This example demonstrates how to initialize and use the DefaultCryptoProvider and DefaultFileStorage. It shows setting an encryption key and configuring a LicenseHandler with these defaults.

```go
cp := crypto_provider.DefaultCryptoProvider{}
cp.SetKey("my-encryption-key")

storage := data_handler.DefaultFileStorage{}
storage.SetCryptoProvider(&cp)

cfg := license_handler.LicenseHandlerConfig{
	ApiKey:      "your-api-key",
	SharedKey:   "your-shared-key",
	ProductCode: "my-product",
	AuthData:    auth.FromKey("LICENSE_KEY"),
	Storage:     storage,
}
```

--------------------------------

### Get Installation File

Source: https://docs.licensespring.com/sdks/android-sdk/licensemanager

Retrieves the latest valid installation file for a given license identity. Requires installation files to be defined in the LicenseSpring platform.

```java
InstallationFile installationFile = licenseManager.getInstallationFile(LicenseIdentity.fromKey("sample-key"));
```

--------------------------------

### Minimal Setup with Defaults (LicenseBundleHandler)

Source: https://docs.licensespring.com/sdks/go-sdk/v2/handler

Shows minimal setup for LicenseBundleHandler using API key or OAuth authentication, default managers, and default file-based storage. Replace placeholder values with your specific configuration details.

```go
bndle_mngr_config := bundle_handler.BundleHandlerConfig{
		ApiKey:       config_file.ApiKey,
		SharedKey:    config_file.SharedKey,
		ClientId:     config_file.ClientId,
		ClientSecret: config_file.ClientSecret,
		BundleCode:   bundleCode,
		AuthData:     auth.FromKey(productAuth.LicenseKey),
		OAuth:        useOAuth,
}

BundleHandler, err := bundle_handler.NewBundleHandler(bndle_mngr_config)
if err != nil {
    log.Fatal(err)
}
```

--------------------------------

### Start Floating Server via Executable

Source: https://docs.licensespring.com/floating-server/floating-server-v2/running-and-administration

Run the binary directly on the host operating system.

```bash
./floating-server
```

--------------------------------

### Check License API Request Examples

Source: https://docs.licensespring.com/license-api/license-check/check-license

Examples for performing a GET request to the /api/v4/check_license endpoint across multiple programming languages.

```bash
curl --location --request GET '/api/v4/check_license?hardware_id=string&product=string&license_key=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
```

```javascript
var request = require('request');
var options = {
  method: 'GET',
  url: '/api/v4/check_license?hardware_id=string&product=string&license_key=string',
  headers: {
    'Accept': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
```

```javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("/api/v4/check_license?hardware_id=string&product=string&license_key=string", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

```python
import requests

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

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

response = requests.get(url, headers=headers)
print(response.text)
```

```ruby
require "uri"
require "net/http"

url = URI("/api/v4/check_license?hardware_id=string&product=string&license_key=string")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body
```

--------------------------------

### License Activation Flow Example

Source: https://docs.licensespring.com/sdks/go-sdk/v2/go-sdk-v2

Demonstrates the license activation process within the LicenseHandler. It calls the LicenseManager to activate the license and then saves the resulting data using the Storage interface.

```go
func (lh *LicenseHandler) ActivateLicense(ctx context.Context) error {
    dl, err := lh.LicenseManager.ActivateLicense(ctx)
    if err != nil {
        return err
    }
    err = lh.Storage.SaveLicense(dl)
    if err != nil {
        return errors.LicenseDataStorageFailed()
    }
    return nil
}
```

--------------------------------

### Getting All Installation Files

Source: https://docs.licensespring.com/sdks/tutorials/best-practices/handling-product-versions

Retrieve the latest InstallationFile releases using the licenseID.

```APIDOC
## Getting All Installation Files

### Description
Developers can retrieve the latest `InstallationFile` releases through the `LicenseManager` object using the `licenseID`.

### Method
GET (Implied, as it's retrieving data)

### Endpoint
`/licenses/{licenseID}/installation-files` (Assumed endpoint structure)

### Parameters
#### Path Parameters
- **licenseID** (string) - Required - The unique identifier for the license.

#### Query Parameters
- **version** (string) - Optional - The desired product version. If not provided, the latest available version will be assumed.
- **options** (object) - Optional - An object to filter install files by channel or environment, as well as the needed version. (Specific to .NET SDK)

### Request Example
(No explicit request body example provided for this operation)

### Response
#### Success Response (200)
- **InstallationFile** (object) - Details about the product installer or setup file.

#### Response Example
(No explicit response body example provided in the source text)

### Notes
- **C++ SDK**: The `getInstallationFile()` method has two additional optional parameters: `productVersion` and `InstallFileFilter`.
- **.NET SDK**: The `GetInstallationFile()` method has one additional parameter: `InstallationFileOptions` for filtering by channel, environment, and version.

### Exceptions
- **C++**: `ProductVersionException` if an installation file is not found for the requested app version.
- **.NET**: `AppVersionNotFoundException` if an installation file is not found for the requested app version.
- **Java**: `LicenseSpringException` if an installation file is not found for the requested app version.
```

--------------------------------

### GET /api/v1/installation-files/{id}/

Source: https://docs.licensespring.com/management-api/product/installation-files/retrieve-installation-file

Retrieves the details of a specific installation file by its ID.

```APIDOC
## GET /api/v1/installation-files/{id}/

### Description
Retrieves the details of a specific installation file by its ID.

### Method
GET

### Endpoint
/api/v1/installation-files/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the installation file.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the installation file.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
- **version** (string) - The version string of the file.
- **full_link** (string) - The download URL for the file.
- **filename** (string) - The name of the file.
- **release_date** (string) - The date of the release.
- **enabled** (boolean) - Whether the file is enabled.
- **hash_md5** (string) - The MD5 hash of the file.
- **environment** (string) - The target environment (e.g., linux64).
- **release_notes_link** (string) - URL to release notes.
- **eula_link** (string) - URL to EULA.
- **size** (string) - File size.
- **requires_version** (string) - The version required to use this file.
- **channel** (string) - The release channel.
- **product** (integer) - The associated product ID.

#### Response Example
{
    "id": 733508,
    "created_at": "2023-04-19T08:23:00Z",
    "updated_at": "2023-04-19T08:27:32Z",
    "version": "1.0.4",
    "full_link": "https://example.com/installation_file_4.zip",
    "filename": "installation_file_4.zip",
    "release_date": "2023-04-05",
    "enabled": true,
    "hash_md5": "aaaaaaaaaaaaaaaaaaaaaaaa",
    "environment": "linux64",
    "release_notes_link": "",
    "eula_link": "",
    "size": "600",
    "requires_version": "1.0.3",
    "channel": "",
    "product": 1586066454419502
}
```

--------------------------------

### Run Online Activation Sample

Source: https://docs.licensespring.com/sdks/go-sdk/v2/samples/how-to-run-the-sample-files

Executes the ExampleOnlineActivation function to activate, check, and deactivate a license.

```go
func main() {
    err := ExampleOnlineActivation(true, "your-product-code")
    if err != nil {
        fmt.Println(err)
    }
}
```

--------------------------------

### Get Product Installation File API

Source: https://docs.licensespring.com/sdks/node.js-sdk/license-api

Retrieves the installation file for a specific product version. Requires authentication, product details, and optionally a version, environment, and channel.

```APIDOC
## POST /api/products/installation-file

### Description
Retrieves the installation file for a specific product and version.

### Method
POST

### Endpoint
/api/products/installation-file

### Parameters
#### Request Body
- **license_key** (string) - Required - The license key.
- **username** (string) - Required - The username associated with the license.
- **product** (string) - Required - The product identifier.
- **hardware_id** (string) - Required - The unique hardware identifier of the device.
- **sdk_ver** (string) - Optional - The version of the SDK being used.
- **env** (string) - Optional - The environment (e.g., 'production', 'staging').
- **channel** (string) - Optional - The distribution channel (e.g., 'stable', 'beta').
- **version** (string) - Optional - The specific version of the product to retrieve.

### Request Example
```json
{
  "license_key": "YOUR_LICENSE_KEY",
  "product": "YOUR_PRODUCT_ID",
  "hardware_id": "YOUR_HARDWARE_ID",
  "version": "1.2.0"
}
```

### Response
#### Success Response (200)
- **id** (number) - The ID of the installation file record.
- **version** (string | undefined) - The version of the product.
- **installation_file** (string | undefined) - The content or URL of the installation file.
- **release_date** (string | null) - The date the version was released.
- **hash_md5** (string | undefined) - The MD5 hash of the installation file.
- **environment** (string) - The environment for which the file is intended.
- **eula_link** (string | undefined) - Link to the End User License Agreement.
- **release_notes_link** (string | undefined) - Link to the release notes.
- **size** (string | undefined) - The size of the installation file.
- **requires_version** (string | undefined) - Minimum required version for this installation.
- **channel** (string) - The distribution channel.
- **company** (object) - Information about the company.
  - **id** (number) - The company ID.

#### Response Example
```json
{
  "id": 987,
  "version": "1.2.0",
  "installation_file": "base64_encoded_file_content...",
  "release_date": "2023-10-26",
  "hash_md5": "d41d8cd98f00b204e9800998ecf8427e",
  "environment": "production",
  "eula_link": "https://example.com/eula",
  "release_notes_link": "https://example.com/releasenotes",
  "size": "10MB",
  "requires_version": "1.0.0",
  "channel": "stable",
  "company": {
    "id": 111
  }
}
```
```
Tokens:
Raw