This repository is a Java reference client implementation for working with the Sypht API.

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.

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

JDK8 and upwards are supported.

brew tap AdoptOpenJDK/openjdk
brew cask install adoptopenjdk8

Sypht Java Client is available on maven central

<dependency>
  <groupId>com.sypht</groupId>
  <artifactId>sypht-java-client</artifactId>
  <version>1.4</version>
</dependency>

// https://mvnrepository.com/artifact/com.sypht/sypht-java-client
compile group: 'com.sypht', name: 'sypht-java-client', version: '1.4'

// https://mvnrepository.com/artifact/com.sypht/sypht-java-client
libraryDependencies += "com.sypht" % "sypht-java-client" % "1.4"

<!-- https://mvnrepository.com/artifact/com.sypht/sypht-java-client -->
<dependency org="com.sypht" name="sypht-java-client" rev="1.4"/>

Populate these system environment variables with the credentials generated above:

SYPHT_API_KEY="<client_id>:<client_secret>"

or

OAUTH_CLIENT_ID="<client_id>"
OAUTH_CLIENT_SECRET="<client_secret>"

then invoke the client with a file of your choice:

SyphtClient client = new SyphtClient();
System.out.println(
        client.result(
                client.upload(
                        new File("receipt.pdf"))));

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

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