Dynamsoft Vision SDK RESTful Service

This project is designed to create a RESTful service for Dynamsoft products, encompassing Dynamic Web TWAIN, Dynamsoft Barcode Reader, Dynamsoft Label Recognizer, and Dynamsoft Document Normalizer. The service is developed with .NET WebAPI and can be tested using the included web client project.

dotnet-restful-service-document-barcode-mrz.mp4

Supported Deployment Platforms

• Windows
• Linux

Getting Started

To get started with the project, follow these steps:

1. Clone the repository to your local machine.

2. Open the project in Visual Studio Code.

3. Request a trial license for each Dynamsoft product you wish to use. Replace the license keys in the LicenseManager.cs file for each product.

4. Start the RESTful service by running the following command in the terminal:

   dotnet run

5. Open the web client project for testing the RESTful service.

   cd client
   npm install
   node app.js

Dynamic Web TWAWIN

Dynamsoft Barcode Reader

Dynamsoft Label Recognizer

Dynamsoft Document Normalizer

Usage

The RESTful service provides endpoints for each of the supported Dynamsoft products, including:

Method	Endpoint	Parameters	Response	Description
GET	/dynamsoft/product	-	Product list	Retrieve all Dynamsoft products.
GET	/dynamsoft/dwt/GetDevices	-	Scanner list	List available scanners.
POST	/dynamsoft/dwt/ScanDocument	Scanner config	Job ID	Initiate a scanning job.
GET	/dynamsoft/dwt/GetImageStream/{jobId}	jobId	Image stream	Fetch image stream for a specific job.
POST	/dynamsoft/dbr/DecodeBarcode	Image stream	Barcode results	Decode barcodes using the Dynamsoft Barcode Reader.
POST	/dynamsoft/ddn/rectifyDocument	Image stream	Mrz results	Detect MRZ from an image with Dynamsoft Label Recognizer.
POST	/dynamsoft/dlr/DetectMrz	Image stream	Rectified document image	Rectify a document with Dynamsoft Document Normalizer.