Vintasoft Web TWAIN service (Windows edition)

In This Topic

VintaSoft Web TWAIN service (Windows edition) is the Windows service that provides Web API for accessing TWAIN/WIA/eSCL image scanners for all users of local computer.

VintaSoft Web TWAIN service (Windows edition) is a .NET Framework 4.7.2 application and it can be used on any Windows (Windows 11/10/8.1/8/7/Vista; Windows Server 2025/2022/2019/2016/2012/2008) computer with installed .NET Framework 4+.

VintaSoft Web TWAIN service (Windows edition) provides access to 64- and 32-bit TWAIN image scanners, 64-bit WIA image scanners, eSCL image scanners if service is installed on 64-bit computer.
VintaSoft Web TWAIN service (Windows edition) provides access to 32-bit TWAIN image scanners, 32-bit WIA image scanner, eSCL image scanners if service is installed on 32-bit computer.

VintaSoft Web TWAIN service (Windows edition) can be accessed via HTTPS protocol using URL "https://localhost:25329/api/VintasoftTwainApi" or via HTTP protocol using URL "http://localhost:25319/api/VintasoftTwainApi".
Network ports 25319 and 25329 can be changed during or after installation of VintaSoft Web TWAIN service.

1. Installation of Vintasoft Web TWAIN service (Windows edition) to a local Windows computer

For installing VintaSoft Web Twain service (Windows edition) to your Windows computer you need to do the following steps:

Download the ZIP-archive with Windows installer from URL: https://www.vintasoft.com/zip/VintasoftWebTwainService-15.5.1.zip
Extract the setup EXE from ZIP-archive into a folder.
Read "description.txt" file for information about command line parameters of installer.
Run "VintasoftWebTwainService-15.5.1-setup.exe" file for installing VintaSoft Web Twain service onto your PC and follow the installation instructions.

2. Uninstallation of Vintasoft Web TWAIN service (Windows edition) from a local Windows computer

For uninstalling VintaSoft Web Twain service (Windows edition) from your Windows computer you need to do the following steps:

Run uninstaller "<Vintasoft_Web_Twain_service_install_path>/uninstall.exe" and follow the deinstallation instructions.

3. Initialization of Vintasoft Web TWAIN service (Windows edition)

Vintasoft Web TWAIN service (Windows edition) has initialization file - "VintasoftWebTwainService.ini" file, which is located in the service folder.
"VintasoftWebTwainService.ini" file can contain the following settings:

HTTPSERVICEPORT - defines the network port for web server that serves HTTP requests to the service. Default value is 25319.
HTTPSSERVICEPORT - defines the network port for web server that serves HTTPS requests to the service. Default value is 25329.
RUN32BITWEBSERVICE - defines a value indicating whether 32-bit service must be used. Parameter can have the following values: 0 - 64-bit service must be started; 1 - 32-bit service must be started. Default value is 0.
ISTWAINSUPPORTENABLED - defines a value whether TWAIN support is enabled. 0 - TWAIN support is disabled; 1 - TWAIN support is enabled.
ISWIASUPPORTENABLED - defines a value whether WIA support is enabled. 0 - WIA support is disabled; 1 - WIA support is enabled.
ISESCLSUPPORTENABLED - defines a value whether eSCL support is enabled. 0 - eSCL support is disabled; 1 - eSCL support is enabled.
LOGGING - defines the logging mode for the service. This parameter can have the following values: 0 - logging is disabled; 1 - logging is enabled; 2 - extended logging is enabled. Default value is 0.
If logging is enabled, the service saves log-information for TWAIN devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService32-debug.log" or "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService64-debug.log".
If logging is enabled, the service saves log-information for WIA devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebWiaService-debug.log".
If logging is enabled, the service saves log-information for eSCL devices to a log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebEsclService-debug.log".
ALLOWABLESESSIONINACTIVITYTIME - defines the interval, in milliseconds, during which the session must be refreshed, i.e. marked as active. Default value is 120000 milliseconds (2 minutes). Minimum value is 100, maximum value is 3600000.

4. Getting information about status of Vintasoft Web TWAIN service (Windows edition)

Vintasoft Web TWAIN service (Windows edition) consists from Windows service (VintaSoftWebTwainService.exe file), which manages the web TWAIN service, and from web TWAIN service (VintaSoftWebTwainService32.exe or VintaSoftWebTwainService64.exe file), which serves requests to TWAIN/eSCL image scanners.

Information about status of Windows service (VintaSoftWebTwainService.exe file) is saved into log-file "<ServiceInstallPath>\VintaSoft\Web TWAIN Service v15.5\log\VSWebTwainService.log".

Information about status of 32-bit web TWAIN service (VintaSoftWebTwainService32.exe file) is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService32.log".
Information about status of 64-bit web TWAIN service (VintaSoftWebTwainService64.exe file) is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService64.log".

Debug information about work with 32-bit TWAIN devices is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService32-debug.log" if TWAIN logging is enabled.
Debug information about work with 64-bit TWAIN devices is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebTwainService64-debug.log" if TWAIN logging is enabled.
Debug information about work with WIA devices is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebWiaService-debug.log" if TWAIN logging is enabled.
Debug information about work with eSCL devices is saved into log-file "C:\Users\%USERNAME%\AppData\Local\Temp\VSWebEsclService-debug.log" if TWAIN logging is enabled.

5. Troubleshooting

5.1 VintaSoft Web TWAIN service (Windows edition) is not available

If you have installed VintaSoft Web TWAIN service (Windows edition) to your Windows computer, but see the error message that service is not available, please open web page "https://localhost:25329/api/VintasoftTwainApi/Status" and see information about VintaSoft Web TWAIN service.
If web page is not available, please check that VintaSoft Web TWAIN service is installed on your Windows computer.
If web page is available but you see the connection warning from the web browser - you have problem with SSL certificate for "localhost" web site.
Please contact VintaSoft support team if you cannot solve the problem.

5.2. Problems with TWAIN image scanners

If you do not see the TWAIN image scanner in device list or TWAIN image scanner works not correctly, please do the following steps:

Get the latest version of TWAIN driver for your image scanner from web site of image scanner manufacturer and re-install the TWAIN driver.
Make sure you have the latest version of VintaSoft Web Twain service (Windows edition).
If you still have the problem, please send information about your problem to our support team and we will try to help you.
We need:
- Snippet of your code. Working project which demonstrates the problem will be welcome.
- Log-file generated by VintaSoft Web Twain service. Please read how to enable logging for VintaSoft Web Twain service (Windows edition) in "Initialization of Vintasoft Web TWAIN service" section above.

5.3. Problems with WIA image scanners

If you do not see the WIA image scanner in device list or WIA image scanner works not correctly, please do the following steps:

Get the latest version of WIA driver for your image scanner from web site of image scanner manufacturer and re-install the WIA driver.
Make sure you have the latest version of VintaSoft Web Twain service (Windows edition).
If you still have the problem, please send information about your problem to our support team and we will try to help you.
We need:
- Snippet of your code. Working project which demonstrates the problem will be welcome.
- Log-file generated by VintaSoft Web Twain service. Please read how to enable logging for VintaSoft Web Twain service (Windows edition) in "Initialization of Vintasoft Web TWAIN service" section above.

5.4. Problems with eSCL image scanners

If you do not see the eSCL image scanner in device list, please do the following steps:

Get IP-address of your Windows computer, get IP-address of eSCL image scanner and make sure that both IP-address are belong to the same network.
Try to use "ping" command to check the network connection with eSCL image scanner.

If you see the eSCL image scanner in device list but eSCL image scanner works not correctly, please do the following steps:

Make sure you have the latest version of VintaSoft Web Twain service (Windows edition).
If you still have the problem, please send information about your problem to our support team and we will try to help you.
We need:
- Snippet of your code. Working project which demonstrates the problem will be welcome.
- Log-file generated by VintaSoft Web Twain service. Please read how to enable logging for VintaSoft Web Twain service (Windows edition) in "Initialization of Vintasoft Web TWAIN service" section above.

Send Feedback