Skip to main content

Getting Started

Get up and running with AmbirScan Web Connect in minutes.

Try It Now​

Want to start scanning immediately without writing any code? A hosted demo application is available at:

https://ambirscanwebconnect.azurewebsites.net

Simply install AmbirScan Web Connect and start the Desktop App (Steps 1 and 2 below), then open the link above in your browser. Select your scanner and start scanning — no web app setup required. This is the fastest way to verify your installation and explore the scanning features.

Prerequisites​

  • OS: Windows 10 or later (64-bit)
  • Browser: Chrome 90+, Edge 90+, or any modern Chromium-based browser (Firefox 90+ is supported with additional certificate setup)
  • Scanner: Any TWAIN-compatible scanner
  • .NET Runtime: .NET 8 Runtime (included in the installer)

Step 1: Install AmbirScan Web Connect​

Download the installer and run it on each client machine that has a scanner connected.

The installer will set up:

  • AmbirScan Web Connect Service — HTTPS REST API on localhost:53052
  • AmbirScan Web Connect Desktop App — TWAIN scanner interface (runs in the system tray)
  • Self-signed HTTPS certificate — Automatically installed and trusted
  • Windows Firewall rules — For localhost communication
note

The installer requires Administrator privileges for certificate and service installation.

Step 2: Start the Desktop App​

The installer does not launch the Desktop App. It starts automatically at every subsequent sign-in, but after the first install you need to start it once yourself, from the Start Menu shortcut:

C:\ProgramData\Microsoft\Windows\Start Menu\Programs\AmbirScan Web Connect

Or search for AmbirScan Web Connect in the Start Menu. Once it starts, its icon appears in the Windows system tray.

note

Until the Desktop App is running, the service has nothing to talk to and scanner requests return HTTP 503.

Step 3: Verify the Installation​

Open a browser and navigate to:

https://localhost:53052/health

You should see a JSON response indicating the service is healthy.

Step 4: Add the JavaScript SDK​

Copy aswcn-scanner-bridge.js into your web application:

<script src="path/to/aswcn-scanner-bridge.js"></script>

Step 5: Scan Your First Document​

// Initialize the scanner bridge
const scanner = new ASWCNScannerBridge();

// Check if the service is running
const isAvailable = await scanner.checkServiceStatus();
if (!isAvailable) {
    alert('Please ensure AmbirScan Web Connect is running.');
    return;
}

// Get available scanners
const sources = await scanner.getSources();
console.log('Available scanners:', sources);

// Open a scanner
await scanner.openSource(sources[0].name);

// Scan a document
const images = await scanner.scan({
    resolution: 300,
    colorMode: 'Color',
    duplexMode: 'Simplex',
    pageSize: 'Letter'
});

// Display the scanned image
images.forEach(image => {
    const img = document.createElement('img');
    img.src = `data:${image.mimeType};base64,${image.base64Data}`;
    document.body.appendChild(img);
});

// Close the scanner when done
await scanner.closeSource();

Step 6: Explore the Sample App​

The repository includes a complete working demo in the sample-app/ directory:

  • scanner-demo.html — Full-featured scanning demo with scanner selection, capabilities, scan parameters, image display, and barcode results
  • scanner-diagnostic.html — Diagnostic tool for testing individual API calls

Next Steps​