Connecting to the Web Services API

To use an API, you must first connect to a Web service. A connection can be established by the "Scanning Operator" (ID=1) role on the "User station" (ID=10) workstation type.

The APIs

You can work with the Web Services API of the ABBYY FlexiCapture 12 Application Server either via SOAP requests, JSON requests or POST requests. The interface to be accessed is determined by the address of the web service:

Method When to use Handler value
SOAP requests Can be used for any operation .../API/v1/Soap
JSON requests Can be used for any operation .../API/v1/Json
POST requests Can be used to optimize file operations, such as uploading files to the server, uploading files in pieces, getting a check sum, downloading files from the server, etc. .../FileService/v1

Authentication methods

In ABBYY FlexiCapture 12, you can connect to the Web Services API either with a Windows account or an ABBYY FlexiCapture account.

For a Windows account you have two options:

  • Windows authentication: NLTM or Negotiate
  • Basic authentication, passing your username and password as Base64-encoded string "username:password"

For an ABBYY FlexiCapture account, add "/FCAuth" to the web service URL. Use Basic authentication first. After one successful call to the service, the response will contain an AuthTicket header with an authorization token that you can use for subsequent requests from the same machine with Bearer authentication.

Note: Add the suffix in the form of ?Tenant=MyTenantName at the end of the API connection address to specify a tenant.

Examples of Web service addresses with different authentication methods

9/12/2022 4:37:50 PM

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.