{"id":31704,"date":"2018-01-09T15:57:14","date_gmt":"2018-01-09T23:57:14","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/developers\/web-services-api\/"},"modified":"2021-08-17T10:00:44","modified_gmt":"2021-08-17T17:00:44","slug":"web-services-api","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/","title":{"rendered":"Transact Web Services API"},"content":{"rendered":"<p>Ephesoft Transact\u2019s 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.<\/p>\n<p>Ephesoft 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.<\/p>\n<p>Ephesoft 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:<\/p>\n<p><strong>http:\/\/&lt;server_name&gt;:&lt;port&gt;\/dcma\/rest\/swagger-ui.html<\/strong><\/p>\n<p>Navigating to this URL will take the user to the Ephesoft Transact Web Services Explorer, as shown below. This interface lists all Ephesoft Transact web services on a single page, allowing both seasoned developers and \u201ccitizen developers\u201d to browse and navigate through the Ephesoft Transact web services available within their server.<\/p>\n<figure id=\"attachment_16420\" aria-describedby=\"caption-attachment-16420\" style=\"width: 458px\" class=\"wp-caption alignnone\"><img decoding=\"async\" class=\"wp-image-16420 size-full\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-6.png\" alt=\"\" width=\"458\" height=\"377\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-6.png 458w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-6-300x247.png 300w\" sizes=\"(max-width: 458px) 100vw, 458px\" \/><figcaption id=\"caption-attachment-16420\" class=\"wp-caption-text\"><span style=\"color: #999999\"><em>Ephesoft Web Services Documentation Screen<\/em><\/span><\/figcaption><\/figure>\n<p>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.<\/p>\n<figure id=\"attachment_16421\" aria-describedby=\"caption-attachment-16421\" style=\"width: 433px\" class=\"wp-caption alignnone\"><img decoding=\"async\" class=\"wp-image-16421 size-full\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-7.png\" alt=\"\" width=\"433\" height=\"309\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-7.png 433w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-7-300x214.png 300w\" sizes=\"(max-width: 433px) 100vw, 433px\" \/><figcaption id=\"caption-attachment-16421\" class=\"wp-caption-text\"><span style=\"color: #999999\"><em>Ephesoft Web Services Implementation Notes<\/em><\/span><\/figcaption><\/figure>\n<p>The overall Ephesoft 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:\/\/&lt;server_name&gt;:&lt;port&gt;\/dcma\/rest\/v2\/api-docs.json<\/p>\n<h2>Ephesoft Transact Web Services Optimized for Workflow Engines<\/h2>\n<p>All Ephesoft Transact web services support the self-documenting capabilities of the OpenAPI Specification, but only two Ephesoft Transact web services, v2\/ocrClassifyExtract and v2\/ocrClassifyExtractBase64, provide simplified JSON responses, allowing them to be embedded into workflow engines like Nintex and Microsoft Flow. These minimized JSON responses have a smaller footprint and improved interoperability. An example of this minimized JSON response is shown below.<\/p>\n<figure id=\"attachment_16422\" aria-describedby=\"caption-attachment-16422\" style=\"width: 380px\" class=\"wp-caption alignnone\"><img decoding=\"async\" class=\"wp-image-16422 size-full\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-8.png\" alt=\"\" width=\"380\" height=\"326\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-8.png 380w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-8-300x257.png 300w\" sizes=\"(max-width: 380px) 100vw, 380px\" \/><figcaption id=\"caption-attachment-16422\" class=\"wp-caption-text\"><span style=\"color: #999999\"><em>Minimized JSON Example<\/em><\/span><\/figcaption><\/figure>\n<p>These two web services have been optimized specifically for advanced workflow engines. See the following links for more information about these two web services:<\/p>\n<ul>\n<li><a href=\"https:\/\/ephesoft.com\/docs\/2019-2\/developers\/web-services-api\/transact-web-service-definitions\/#58\">v2\/ocrClassifyExtract<\/a><\/li>\n<li><a href=\"https:\/\/ephesoft.com\/docs\/2019-2\/developers\/web-services-api\/transact-web-service-definitions\/#59\">v2\/ocrClassifyExtractBase64<\/a><\/li>\n<\/ul>\n<p>Because they support minimized JSON responses, these two web services can be fully integrated into advanced workflow engines such as Nintex or Microsoft Flow. These tools allow users to develop complex workflows that can integrate different products and services together, enabling decision-making processes with or without human intervention.<\/p>\n<p>For example, a workflow can easily be constructed to monitor Box to look for any new invoices created in the \u201cIncoming\u201d folder. When a new invoice is created in that folder, the v2\/ocrClassifyExtract web service can extract the invoice amount from the invoice and feed that data into a decision tree. Invoices with amounts of $1000 or less can be approved automatically and routed to a \u201cProcessed\u201d folder in Box. Invoices with amounts greater than $1000 can trigger a notification for an employee to review and approve the invoice before releasing it to the \u201cProcessed\u201d folder.<\/p>\n<p><b>Note<\/b>: Currently we support only basic authentication for Transact web services (base 64 encoded user name and password). Token-based authentication usually used with SAML, OAuth, and other Single Sign-On authentication frameworks are not supported.<\/p>\n","protected":false},"featured_media":0,"parent":31685,"menu_order":7,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v19.0 (Yoast SEO v22.1) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Transact Web Services API | Ephesoft Docs<\/title>\n<meta name=\"robots\" content=\"noindex, follow\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Transact Web Services API\" \/>\n<meta property=\"og:description\" content=\"Ephesoft Transact\u2019s OpenAPI-Compliant web services provide a simple method for real-time integration and exposure of Ephesoft Transact capabilities to external [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2021-08-17T17:00:44+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-6.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/\",\"name\":\"Transact Web Services API | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2018-01-09T23:57:14+00:00\",\"dateModified\":\"2021-08-17T17:00:44+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/ephesoft.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transact\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Developer Documentation\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Transact Web Services API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\",\"url\":\"https:\/\/ephesoft.com\/docs\/\",\"name\":\"Ephesoft Docs\",\"description\":\"Intelligent Document Processing Made Easy\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ephesoft.com\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Transact Web Services API | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Transact Web Services API","og_description":"Ephesoft Transact\u2019s OpenAPI-Compliant web services provide a simple method for real-time integration and exposure of Ephesoft Transact capabilities to external [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/","og_site_name":"Ephesoft Docs","article_modified_time":"2021-08-17T17:00:44+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2018\/01\/word-image-6.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/","name":"Transact Web Services API | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2018-01-09T23:57:14+00:00","dateModified":"2021-08-17T17:00:44+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/web-services-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/ephesoft.com\/docs\/"},{"@type":"ListItem","position":2,"name":"Transact","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/"},{"@type":"ListItem","position":3,"name":"Developer Documentation","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/"},{"@type":"ListItem","position":4,"name":"Transact Web Services API"}]},{"@type":"WebSite","@id":"https:\/\/ephesoft.com\/docs\/#website","url":"https:\/\/ephesoft.com\/docs\/","name":"Ephesoft Docs","description":"Intelligent Document Processing Made Easy","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ephesoft.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"comment_count":0,"_links":{"self":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31704"}],"collection":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/comments?post=31704"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31704\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31685"}],"prev":[{"title":"Scripting Resources","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/developers\/scripting-guide\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31688"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31704"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31704"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}