Dynamic Web TWAIN



This guide provides instructions on how to use Dynamsoft’s Dynamic Web TWAIN SDK. It provides an overview of most of the things you can achieve with the SDK.


This guide is meant for all developers interested in the Dynamic Web TWAIN SDK.

For new developers, there is a step-by-step guide to help you develop a scanning page in your web application from scratch.

For those who have used the SDK before, you can find information on advanced or new APIs that you can use to polish your scanning page.

Get Started

What is TWAIN | ICA | SANE

TWAIN is a standard software protocol and application programming interface (API) that regulates communication between software applications and imaging devices such as scanners and digital cameras.

The TWAIN standard, including the specification, data source manager and sample code, is maintained by the not-for-profit organization TWAIN Working Group.

Dynamsoft Corporation is a member of the TWAIN Working Group.

The TWAIN protocol works very well on Windows but not as good on macOS. Thus, a substitute is also used by Dynamsoft’s SDK on macOS which is called Image Capture Architecture or ICA for short.

On Linux, TWAIN isn’t available; therefore SANE is used. As described on the official introduction page, SANE stands for "Scanner Access Now Easy" and is an application programming interface (API) that provides standardized access to any raster image scanner hardware such as flatbed scanners, hand-held scanners, video and still cameras, frame-grabbers.

What is Dynamic Web TWAIN

Dynamic Web TWAIN is a scanning SDK specifically optimized for web applications. It was initially designed for Windows at the beginning, and only TWAIN protocol was supported at the time which is why TWAIN is in the name of the SDK. However, it has been dramatically improved and extended over the years, and now it supports TWAIN on Windows & macOS, ICA on macOS and SANE on Linux. The SDK enables you to write code, in just a few lines, to scan documents from a TWAIN|ICA|SANE compliant device which typically is a scanner. Users can then edit the images, save them locally, or upload them to a remote server in a variety of formats.

With the SDK, you can also import files in the formats BMP|JPG|PNG|TIF|PDF from a local disk or the web via HTTP(s) or FTP.

Basic Requirements

Server Side

  • Operating System: Windows, macOS, Linux, etc.
  • Web Server: IIS, Apache, Tomcat, NGINX, WebSphere, ColdFusion, etc.
  • Programming Languages:
    • Front-end: HTML, JavaScript, TypeScript, CSS, etc.
    • Back-end: ASP.NET (C# and VB), PHP, JSP (JAVA), ASP, Python, NodeJS, etc.

Client Side

  • Browser/OS Support
    • Windows 7/10/2008/2012/2016; 32-bit and 64-bit (recommended)
      • IE 8-9: ActiveX
      • IE 10-11: HTML5/ActiveX
      • Edge: HTML5
      • Chrome/Firefox 27+: HTML5
    • Mac OS X 10.7 and later
      • Chrome/Firefox 27+, Safari 7+: HTML5
    • Ubuntu Ubuntu 16.04+, Debian 8+; 64-bit
      • Chrome/Firefox 27+: HTML5
    • IOS
      • Safari v11+: MBC
    • Android
      • Chrome v58+: MBC

Choose which Dynamic Web TWAIN Edition to use

Dynamic Web TWAIN has five editions: ActiveX, HTML5 for Windows, HTML5 for Mac, HTML5 for Linux and Mobile Browser Capture for IOS & Android. Based on the browser(s) your end users use, you can decide which edition(s) you need.

  • ActiveX: supports IE 8-9 by default, it can be configured to support IE 10, 11 as well
  • HTML5 for Windows: supports Firefox/Chrome 27+, IE 10/11 and Edge
  • HTML5 for Mac: supports Chrome/Firefox 27+, Safari 7+
  • HTML5 for Linux: supports Chrome/Firefox 27+
  • MBC for IOS & Android: supports Safari v11+ on IOS and Chrome v58+ on Android

results matching ""

    No results matching ""

    results matching ""

      No results matching ""