Open API Overview

The Open API is a component of ABBYY FineReader Server. It can be installed onto any computer in the network. ABBYY FineReader Server provides two types of Open API for integration with external systems: a COM-based API and a Web Services API.

The COM-based API uses RPC technology, and can be used for integration with other systems in the local area network. In case of the COM-based API you need to install required components of ABBYY FineReader Server on the computer where the client application is installed. See Distribution of Applications Using the ABBYY FineReader Server COM-based API Library for details.

The Web services API enables communication with remote systems via HTTP, and therefore allows for remote integration over the Internet. In case of the Web services API you do not need to install any components on the client computer.

The ABBYY FineReader Server 14 Web Services API includes a SOAP API and a REST API (added in Update 8).

See Using the Web Services API for details.

Note. The FineReader Server Web Services API may require very complex configuration, if it is installed on the same computer with Microsoft Office SharePoint Server. It is not recommended to install them on the same computer.

Note. The Web Services API will not work if ASP.NET is not installed on your computer. When installing Microsoft .Net Framework ASP.NET is copied on the computer but not installed. You should install it manually by running: C:\WINDOWS\Microsoft.NET\Framework\vX.X.XXX\aspnet_regiis.exe -i (specify the appropriate version instead of vX.X.XXX).

This section will provide detailed descriptions of the Open API objects, their properties, and methods. These objects allow you to create XML Tickets, manage jobs, analyze XML Results, and specify preprocessing, recognition and export parameters.

29.08.2023 11:55:29

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.