Using the Web Services API

The Web Services API provides two services — the WebService service and the ServerManager service.

WebService

This service is used to receive information about the available workflows, send jobs to workflows by means of the API, track job states, and receive the results.

By default, the service is available via the following address: http://<ServerName>/FineReaderServer14/WebService.asmx

To generate a WSDL description, connect to http://<ServerName>/FineReaderServer14/WebService.asmx?WSDL

See also WebService Object

ServerManager

This service was added in Update 8 and provides information about the server, including a list of licenses and the job queue.

By default, the service is available via the following address: http://<ServerName>/FineReaderServer14/ServerManager.asmx

To generate a WSDL description, connect to http://<ServerName>/FineReaderServer14/ServerManager.asmx?WSDL

See also ServerManager Object

In order to use the Web Services API:

  • The COM-based API has to be installed and properly configured on the computer with ABBYY FineReader Server (see Using the COM-based API within 64-bit applications for details).
  • Internet Information Services version 7 or higher and .NetFramework v.4.5 must be installed on the computer with ABBYY FineReader Server.

The ABBYY FineReader Server setup program will automatically configure the system to use the COM-based API.

For troubleshooting, consider the steps required for manual configuration:

  1. An application pool should be created in IIS to host the ABBYY FineReader Server Web Services API application. This application pool must have the following properties:
    • Name = ABBYY FineReader Server 14
    • .NetFramework version = v.4.0 (.NetFramework 4.5 should be installed on the computer)
    • Managed Pipeline Mode = Integrated
    • Identity = "LocalSystem" (default) or the user that was specified in the setup wizard. It is important that the application pool be configured to run under the same user account that is used for running the ABBYY FineReader Server service (Select Start  > Control Panel  > Administrative Tools  > Services and see ABBYY FineReader Server 14 Server Manager service).
  2. A virtual application should be created in the folder [ABBYY FineReader Server 14 installation folder]\\FineReaderServerWS. This application must have the following properties:
    • Application Pool = "ABBYY FineReader Server 14" (created in step 1)
    • Virtual path = /FineReaderServer14

To complete these steps or to review the current settings, click Start  > Control Panel  > Administrative Tools  > Internet Information Services (IIS) Manager.

You can use one of the following two methods to automatically create clients:

See also

Using the Web Services API within 64-bit ASP.NET

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.