Install Document Reader Web Service API on Windows

Learn how to install the Document Reader Web Service API on Windows and set up its license.

• Install Document Reader Web Service API
• Download Regula Licensing App
• Obtain License Key
• Install License
  • Via licensing app
  • Manually
• Apply Changes

Install Document Reader Web Service API

The Document Reader Web Service API supports the x86 and x64 architectures.

Warning

Due to technical limitations, the Windows setup supports running only a single worker. For multi-worker setups, use Docker or Linux. Both environments support multi-worker configurations.

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

You only need Regula Downloads Manager to download the installation package. You do not need Regula Downloads Manager to run the Document Reader Web Service API.

To install the Document Reader Web Service API:

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

2. Follow the Installation Wizard instructions. The Installation Wizard installs all required prerequisites, registers the service, and starts it automatically.

Download Regula Licensing App

Regula Licensing is a utility for license key management and monitoring. You can download Regula Licensing using the Regula Downloads Manager.

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

Obtain License Key

For demonstration and testing purposes, you can download a test license from the My Licenses section in the Regula Client Portal.

To run the Document Reader Web Service API on premises, you need a production license key.

To obtain the production license key, follow these steps:

1. Launch the Regula Licensing application.

2. Click the Save System Info button:

3. Regula Licensing automatically generates a .sysinfo file. Send it to your Sales Manager to request a production license, or use Send System Info to send the request directly to our support team. When contacting support, specify your contact details. You can also include a brief description of your use case or project.

For more information about available licensing options, see the Document Reader SDK Licensing page.

You typically receive the production license as a regula.license file. You can install it using the Regula Licensing application or manually.

Install License

You can install the license in two ways:

• Using the Regula Licensing application (recommended)
• Manually

Via licensing app

Info

You can download the Regula Licensing app from the Regula Downloads Manager in the Other Products tab.

To install the license using the Regula Licensing application:

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. Verify that the application displays the license information:

Manually

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

Document Reader Web Service API (x64)Document Reader Web Service API (x86)

%PROGRAMFILES%\Regula\Document Reader Web API\extBin\win_x64

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

Apply Changes

After you install the license, restart the Regula Document Reader Service to apply the changes: