Skip to content

Node.js wrapper for Dynamsoft Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.

License

Notifications You must be signed in to change notification settings

yushulx/docscan4nodejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docscan4nodejs

The package provides Node.js APIs for invoking Dynamsoft Service REST API. It helps developers to create desktop or server-side document scanning applications with ease.

Supported Scanner Drivers

  • TWAIN
  • WIA
  • SANE
  • ICA
  • eSCL

Supported Platforms

  • Windows
  • Linux
  • macOS

Prerequisites

Dynamsoft Service Configuration

After installing the Dynamsoft Service, navigate to http://127.0.0.1:18625/ in a web browser to configure the host and port settings. The default host IP address is set to 127.0.0.1. If you wish to make the service accessible over the local network in your office or company, you can update the host setting to a LAN IP address, such as 192.168.8.72.

dynamsoft-service-config

REST API Reference

By default, the REST API's host address is set to http://127.0.0.1:18622.

Method Endpoint Description Parameters Response
GET /DWTAPI/Scanners Get a list of scanners None 200 OK with scanner list
POST /DWTAPI/ScanJobs Creates a scan job license, device, config 201 Created with job ID
GET /DWTAPI/ScanJobs/:id/NextDocument Retrieves a document image id: Job ID 200 OK with image stream
DELETE /DWTAPI/ScanJobs/:id Deletes a scan job id: Job ID 200 OK

Node.js API

  • getDevices(host, scannerType) - Get all available scanners. It returns an array of scanner objects.
  • scanDocument(host, parameters, timeout) - Create a scanner job by feeding one or multiple physical documents. It returns the job id.
  • getImageFile(host, jobId, directory) - Get one document image by job id. The directory specifies the physical location to save the images. It returns the image path.
  • getImageFiles(host, jobId, directory) - Get document images by job id. The directory specifies the physical location to save the images. It returns an array of image paths.
  • deleteJob(host, jobId) - Delete a scan job by job id. It can interrupt the scan process.
  • getImageStreams(host, jobId) - Get document images by job id. It returns an array of image streams.

Parameter Configuration

The parameter configuration is based on Dynamsoft Web TWAIN documentation. It controls the behavior of the scanner.

For example, you can set the resolution to 200 DPI and the pixel type to color:

let parameters = {
    license: "LICENSE-KEY",
    device: devices[index].device,
};

parameters.config = {
    IfShowUI: false,
    PixelType: 2, // color
    Resolution: 200,
    IfFeederEnabled: false,
    IfDuplexEnabled: false,
};

Examples

Set the LICENSE-KEY before running the following examples.

About

Node.js wrapper for Dynamsoft Service, supporting document scanning from TWAIN, WIA, ICA, SANE and eSCL scanners.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published