Sypht Golang Client

This repository is a Golang reference client 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

Go - supports Go 1.13 or greater.

Installation

$ go get github.com/sypht-team/sypht-golang-client

Usage

Populate system environment variable with the credentials generated above:

SYPHT_API_KEY="$client_id:$client_secret"

Updated 30/06/2020 We are in the process of deprecating our legacy authentication endpoint. To use new authentication endpoint

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

For more info

then invoke the client with a file of your choice:

client, _ := sypht.NewSyphtClient(os.Getenv("SYPHT_API_KEY"), nil)

	uploaded, _ := client.Upload(fileName, []string{
		sypht.Invoice,
		sypht.Document,
	}, "")

	result, _ := client.Results(uploaded.FileID)
	fmt.Println(result)

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.