📢 ATTN: This client is obsolete and will no longer receive updates given that ScanR is out of business. 📢

NET library for the ScanR REST API

This library interacts with the ScanR REST API allowing you to utilize ScanR's features using a .NET interface.

Getting Started
How To Use
Authentication
Direct upload images
Direct upload Pdfs
Public Urls

Getting Started

First you need to sign up for the ScanR and obtain your unique API Token. Once you have set up your account, you can start using ScanR.

How to use

You can convert/can your documents by providing the URL of the document you want to to text or upload the document directly instead. Just keep in mind that the document URL must be accessible for ScanR.

Authentication

The first step is to authenticate to ScanR API by providing your unique AAPI Token while creating a new connection.

 var connection = ScanRConnection.Create("token");

Direct upload images

ScanR allows you to easily upload your images as can be seen within the example below:

File path (Byte array also supported)

var client = new ScanRClient(connection);

var response = await client.Scan(
		"document-location-on-disk.png",
                Language.English
                );

if (response.Success)
    var text = response.Body.Text

Direct upload Pdfs

Pdfs can have multiple results which is based on the amount of pages included within the document. Therefore, the call returns a different result as shown within the examples below:

File path (Byte array also supported)

var client = new ScanRClient(connection);

var response = await client.ScanPdf(
		"document-location-on-disk.pdf",
                Language.English
                );

if (response.Success)
    var text = response.Body.Text // Array of items for each page

Public Urls

If the resource is already available on the web, it's not necessary to upload the document. Just add the public URL as included within this sample.

Public Url for Images

var client = new ScanRClient(connection);

var response = await client.Scan(
		new Uri("http://blah.blah/image.png")
                Language.English
                );

if (response.Success)
    var text = response.Body.Text

Public Url for Pdfs

var client = new ScanRClient(connection);

var response = await client.ScanPdf(
		new Uri("http://blah.blah/image.pdf")
                Language.English
                );

if (response.Success)
    var text = response.Body.Text // Array of items for each page

LICENSE - MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Kevin-Bronsdijk/scanr-net