https://github.com/sypht-team/sypht-csharp-client

A C# / .NET client for the Sypht API
https://github.com/sypht-team/sypht-csharp-client

api-client data-extraction document-capture dot-net dotnet dotnet-cli dotnet-library extract extract-data-from-pdf extract-fields invoice invoice-parser pdf-parser receipt-capture receipt-reader receipt-scanner receipt-scanning sypht sypht-api sypht-csharp-client

Last synced: about 1 month ago
JSON representation

A C# / .NET client for the Sypht API

• Host: GitHub
• URL: https://github.com/sypht-team/sypht-csharp-client
• Owner: sypht-team
• License: apache-2.0
• Created: 2019-09-14T13:44:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T06:06:08.000Z (about 2 years ago)
• Last Synced: 2023-03-03T02:01:28.864Z (almost 2 years ago)
• Topics: api-client, data-extraction, document-capture, dot-net, dotnet, dotnet-cli, dotnet-library, extract, extract-data-from-pdf, extract-fields, invoice, invoice-parser, pdf-parser, receipt-capture, receipt-reader, receipt-scanner, receipt-scanning, sypht, sypht-api, sypht-csharp-client
• Language: C#
• Homepage:
• Size: 65.4 KB
• Stars: 6
• Watchers: 6
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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](https://sypht.com) is a SaaS [API]((https://docs.sypht.com/)) 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 `` and ``, which can be obtained by registering

for an [account](https://www.sypht.com/signup/developer)

## Prerequisites

* supports .NET Core 3.1

## Usage

Populate system environment variable with the credentials generated above:

```Bash

export SYPHT_API_KEY=":"

```

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

```Bash

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

```

install the json.net dependency

```Bash

dotnet add package Newtonsoft.Json --version 12.0.2

```

then invoke the example file under examples/simple.cs

```Bash

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](https://github.com/sypht-team/sypht-csharp-client/blob/master/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](https://github.com/sypht-team/sypht-csharp-client/blob/master/CODE_OF_CONDUCT.md).