Generate License

This documentation details the steps required to generate a full license. If you wish to use a trial license, please see the License page for the 1-step generation process.

Note:

Before a license can be generated, Api2File must be installed on the target server. If you haven't yet installed Api2File, please check out the installation guide.

Api2File provides a dedicated application to provide the information required to generate a license. When run, it outputs a unique character string that that represents that server during the licensing process. This allows licenses to be generated that can be used on servers disconnected from the internet.

Retrieving the DeviceId

The server Device Id is key to the licensing process. Each server has a different Device Id and it is therefore important to ensure that during the licensing process the correct Device Id is provided. The simplest way to ensure this is to only generate the Device Id for the target server.

During the installation process, a Api2file.DeviceId.Cli executable file is also installed. Use this to generate the server Device Id.

Windows

It is recommended to run all commands within a Command Prompt, so the application output can be viewed and copied easily.

  1. Navigate to the installation directory of Api2File.
  2. Run the Api2file.DeviceId.Cli.exe
  3. Copy the 'Device Identifier' value.

Linux

  1. Navigate to the installation directory of Api2File.
  2. Run the Api2file.DeviceId.Cli executable.
  3. Copy the 'Device Identifier' value.
Example: Api2File.DeviceId.Cli output on Windows
Api2File.DeviceId v1.0.0

╔═══════════════════════════════════╦══════════════════════════════════════════════════════════╗
║ OS                                │ Device Identifier                                        ║
╠───────────────────────────────────┼──────────────────────────────────────────────────────────╣
║ Microsoft Windows NT 10.0.19045.0 │ A2FTZFBMQTAD7GTYWMXD3EXAMPLEG86NYAGYKYD16EA1H3H1JE9BYZ03 ║
╚═══════════════════════════════════╩══════════════════════════════════════════════════════════╝

Use the Device Identifier above at https://www.api2file.net/account to generate license files.
                                                    

Generation

Full licenses are generated from the account page. Log into your account and use the license generator at the bottom of the page

License Installation

Licenses are 'installed' by copying the .lic file into the configured License directory. By default, this directory is named licenses within the root of the installation directory. The License directory can be overridden using the AppSettings configuration file.

< Previous topic
Install
 
Next topic >
Configure