sypht-team / sypht-csharp-client

A C# / .NET client for the Sypht API

Sypht C# Client

This repository is a C# / .NET sample implementation for working with the Sypht API at https://api.sypht.com.

About Sypht

Sypht is a SaaS API which extracts key fields from documents. For example, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number and biller information.

Getting started

To get started you'll need API credentials, i.e. a <client_id> and <client_secret>, which can be obtained by registering for an account

Prerequisites

• supports .NET Core 3.1

Usage

Populate system environment variable with the credentials generated above:

export SYPHT_API_KEY="<client_id>:<client_secret>"

If credentials were issued after 16th June 2020, please use one more system environment variable:

export SYPHT_AUTH_ENDPOINT="https://auth.sypht.com/oauth2/token"

install the json.net dependency

dotnet add package Newtonsoft.Json --version 12.0.2

then invoke the example file under examples/simple.cs

dotnet clean
dotnet build
dotnet run examples/simple.cs

License

The software in this repository is available as open source under the terms of the Apache License.

Code of Conduct

Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.