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

A Java client for the Sypht API
https://github.com/sypht-team/sypht-java-client

api-client data-extraction document-capture extract extract-data-from-pdf extract-fields information-retrieval information-retrieval-engine invoice invoice-parser java java8 pdf-parser receipt-capture receipt-reader receipt-scanner receipt-scanning sypht sypht-api sypht-java-client

Last synced: about 17 hours ago
JSON representation

A Java client for the Sypht API

• Host: GitHub
• URL: https://github.com/sypht-team/sypht-java-client
• Owner: sypht-team
• License: apache-2.0
• Created: 2019-04-05T04:39:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-04T01:52:55.000Z (over 3 years ago)
• Last Synced: 2024-09-25T01:39:09.123Z (about 19 hours ago)
• Topics: api-client, data-extraction, document-capture, extract, extract-data-from-pdf, extract-fields, information-retrieval, information-retrieval-engine, invoice, invoice-parser, java, java8, pdf-parser, receipt-capture, receipt-reader, receipt-scanner, receipt-scanning, sypht, sypht-api, sypht-java-client
• Language: Java
• Homepage: https://sypht.com
• Size: 108 KB
• Stars: 88
• Watchers: 5
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/sypht-team/sypht-java-client.svg?branch=master)](https://travis-ci.com/sypht-team/sypht-java-client.svg?branch=master) [![codecov](https://codecov.io/gh/sypht-team/sypht-java-client/branch/master/graph/badge.svg)](https://codecov.io/gh/sypht-team/sypht-java-client)

# Sypht Java Client

This repository is a Java reference client implementation for working with the Sypht API. [![Docs](https://img.shields.io/badge/API%20Docs-site-lightgrey.svg?style=flat-square)](https://docs.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

JDK8 and upwards are supported.

```Bash

brew tap AdoptOpenJDK/openjdk

brew cask install adoptopenjdk8

```

## Installation

Sypht Java Client is available on maven central

### Maven

```Xml

  com.sypht

  sypht-java-client

  1.4

```

### Gradle

```Gradle

// https://mvnrepository.com/artifact/com.sypht/sypht-java-client

compile group: 'com.sypht', name: 'sypht-java-client', version: '1.4'

```

### SBT

```SBT

// https://mvnrepository.com/artifact/com.sypht/sypht-java-client

libraryDependencies += "com.sypht" % "sypht-java-client" % "1.4"

```

### Ivy

```Ivy

```

## Usage

Populate these system environment variables with the credentials generated above:

```Bash

SYPHT_API_KEY=":"

```

or

```Bash

OAUTH_CLIENT_ID=""

OAUTH_CLIENT_SECRET=""

```

then invoke the client with a file of your choice:

```Java

SyphtClient client = new SyphtClient();

System.out.println(

        client.result(

                client.upload(

                        new File("receipt.pdf"))));

```

## License

The software in this repository is available as open source under the terms of the [Apache License](https://github.com/sypht-team/sypht-java-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-java-client/blob/master/CODE_OF_CONDUCT.md).