There are two Aluma client libraries for .NET, which make it easy to process documents using the Aluma service.

The HTTP client is a basic client which makes it easy to process a document and handles all HTTP requests and responses for you, in a reliable way. This client is best for simple single-document scenarios such as scanning or simple interactive applications.

The Pipelines client is a higher-level client, built on the HTTP client, that makes it easy to process multiple documents in parallel either continuously as they arrive or as a one-off batch. This client is best when you need to handle documents arriving as part a business process, or when you need to process a large number of documents in a document management system or archive.

Both clients are available as NuGet packages and target netstandard 2.0, so can be used in .NET Framework and .NET Core projects.

The source code for the clients, including samples and tests, is open-source and available in our GitLab repository here: Aluma .NET client libraries

Installing the samples

A number of sample projects that demonstrate how to use the clients can be found in the clients' GitLab repository. These include:

  • HTTP client Basic Usage. Illustrates very basic use of the HTTP client to process a single document
  • Pipeline client Process Batch. Illustrates use of the Pipelines client to process a one-off batch of documents
  • Pipeline client Process Continuously. Illustrates use of the Pipelines client to process a stream of documents arriving continuously over time

You can clone the repository using the following command:

 git clone [email protected]:aluma-clients/aluma-dotnet.git

The Aluma.NET.sln includes the samples and also the client source and tests, should you find these useful.

We suggest checking out the HTTP client sample first, followed by the two Pipeline client samples. They are extensively commented to highlight the key points.

Before running the samples, you will need to edit the MyAPICredentials classes to specify some API client credentials. You can create new API clients and access their credentials in the Aluma dashboard.