sypht-java-client

Sypht is an service which extracts key fields from documents. https://www.sypht.com

License	The Apache License, Version 2.0
Categories	Java Languages CLI User Interface
GroupId	com.sypht
ArtifactId	sypht-java-client
Last Version	1.3
Release Date	Sep 16, 2019
Type	jar
Description	sypht-java-client Sypht is an service which extracts key fields from documents. https://www.sypht.com
Project URL	http://maven.apache.org
Source Code Management	https://github.com/sypht-team/sypht-java-client.git

Download sypht-java-client

Filename	Size
sypht-java-client-1.3.pom
sypht-java-client-1.3.jar	10 KB
sypht-java-client-1.3-sources.jar	7 KB
sypht-java-client-1.3-javadoc.jar	43 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.sypht/sypht-java-client/ -->
<dependency>
    <groupId>com.sypht</groupId>
    <artifactId>sypht-java-client</artifactId>
    <version>1.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.sypht/sypht-java-client/
implementation 'com.sypht:sypht-java-client:1.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.sypht/sypht-java-client/
implementation ("com.sypht:sypht-java-client:1.3")

Apache Buildr

'com.sypht:sypht-java-client:jar:1.3'

Apache Ivy

<dependency org="com.sypht" name="sypht-java-client" rev="1.3">
  <artifact name="sypht-java-client" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.sypht', module='sypht-java-client', version='1.3')
)

Scala SBT

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

Leiningen

[com.sypht/sypht-java-client "1.3"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.apache.httpcomponents : httpclient	jar	4.5.8
org.apache.httpcomponents : httpmime	jar	4.5.8
org.json : json	jar	20180813
io.jsonwebtoken : jjwt-api	jar	0.10.5

runtime (2)

Group / Artifact	Type	Version
io.jsonwebtoken : jjwt-impl	jar	0.10.5
io.jsonwebtoken : jjwt-jackson	jar	0.10.5

test (2)

Group / Artifact	Type	Version
junit : junit	jar	3.8.1
com.github.stefanbirkner : system-rules	jar	1.19.0

Project Modules

There are no modules declared in this project.

Sypht Java Client

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

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

JDK8 and upwards are supported.

brew tap AdoptOpenJDK/openjdk
brew cask install adoptopenjdk8

Installation

Sypht Java Client is available on maven central

Maven

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

Gradle

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

SBT

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

Ivy

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

Usage

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"))));

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.

Sypht

Sypht team official Github account

Versions

Version
1.3 Sep 16, 2019
1.2 Apr 10, 2019
1.1 Apr 9, 2019
1.0 Apr 5, 2019