Transact's OpenAPI-Compliant web services provide a simple method for real-time integration and exposure of Ephesoft Transact capabilities to external applications, allowing developers to embed advanced capture features in their own solutions without having to display the Transact user interface.

Transact provides over 60 Transact web services to perform advanced capture actions in your custom applications. These web services perform tasks that range from simple actions like determining which batch instances can be seen by an individual user, to performing complete OCR, classification, or extraction procedures on a collection of documents.

Transact web services support the self-documenting feature of the OpenAPI Specification v2.4.0 (formerly known as the Swagger Specification). This means that tools like Swagger UI can be used to browse the collection of web services and view detailed documentation for each web service. The Swagger UI tool is bundled with Ephesoft Transact, and can be accessed by navigating to the following URL in your Transact instance:

http://<server_name>:<port>/dcma/rest/swagger-ui.html

Navigating to this URL will take the user to the Transact Web Services Explorer. This interface lists all Transact web services on a single page, allowing both seasoned developers and "citizen developers" to browse and navigate through the Transact web services available within their server.

This interface also allows the user to review detailed information about each web service. Clicking a web service in the Web Services Explorer allows you to drill further into the web service to view additional details, as shown below.

The overall Transact OpenAPI-compliant web services definition file for all API endpoints is represented in JSON format. This definition file can be found at the following location in your Transact instance:

http://<server_name>:<port>/dcma/rest/v2/api-docs.json