Skip to content

Windows

How to install the Document Reader Web API and set up a license.

Install Document Reader Web API

You can download the Web API by using the Regula Downloads Manager.

Please note, the Regula Downloads Manager is required only for the download of the package and has no further impact on the Regula Document Reader Web API operation.

Info

Document Reader Web API is supported on the (x86) and (x64) architectures.

  1. In the Document Reader SDK tab, select the Document Reader Web API checkboxes and click the Download And Run button:

  1. Follow the Installation Wizard instructions. The Installation Wizard will set up all required prerequisites, register, and automatically start the service.

Download Regula Licensing

Regula Licensing is a utility for license key management and monitoring. The tool is available for download here: Regula Downloads Manager

Go to the Other Products tab and download Regula Licensing as shown below:

Obtain License Key

For the on-prem operation of the Document Reader Web API, a license key is required.

To obtain the license key, take the following steps:

  1. Launch the Regula Licensing application.
  2. Click the Save System Info button:

  1. The .sysinfo file will be generated automatically. Send it to your Sales Manager for further actions or use ‘Send System Info’ to send the request directly to our support team specifying your contact details. Some comments on the use-case/project will be much appreciated.

As soon as you receive the license key, you can implement it manually or by using the Regula Licensing application.

Set Up License

To access all the capabilities of the Document Reader Web API, a license is required.

To get the production license or any purchasing information, please submit an inquiry and our sales team will contact you shortly.

Manually

1. Copy the obtained regula.license file to the following folder:

%PROGRAMFILES%\Regula\Document Reader Web API\extBin\win_x64
%PROGRAMFILES(x86)%\Regula\Document Reader Web API\extBin\win_x86

2. Restart the Document Reader Web API service:

Using Regula Licensing Application

Info

The Regula Licensing app is available for download via the Regula Downloads Manager in the Other Products tab.

1. Launch the Regula Licensing application.

2. Click the Install license button and select the license file regula.license or drag and drop the license file into the application window:

3. Make sure the license key is installed correctly and the license key information is displayed as follows:

4. Restart the Document Reader Web API service:

Back to top