Sypht Nodejs Client

This repository is a Nodejs 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

• Node.js version 8+.

Installation

npm install sypht-node-client

Usage

Populate system environment variable with the credentials generated above:

SYPHT_API_KEY="$client_id:$client_secret"
SYPHT_AUTH_ENDPOINT="https://auth.sypht.com/oauth2/token"
# use https://login.sypht.com/oauth/token for legacy keys

then invoke the client with a file of your choice:

var sypht = require('sypht-node-client');

async function main () {
    var data = await sypht.fileUpload(['sypht.invoice', 'sypht.document'], './sample_invoice.pdf');
    data = await sypht.fetchResults(data['fileId']);
    console.log(JSON.stringify(data, null, 2));
} 

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.