https://github.com/sypht-team/sypht-node-client
A Nodejs client for the Sypht API
https://github.com/sypht-team/sypht-node-client
api-client data-extraction document-capture extract extract-data-from-pdf extract-fields invoice invoice-parser node node-module nodejs nodejs-client pdf-parser receipt-capture receipt-reader receipt-scanner receipt-scanning sypht sypht-api sypht-node-client
Last synced: 3 months ago
JSON representation
A Nodejs client for the Sypht API
- Host: GitHub
- URL: https://github.com/sypht-team/sypht-node-client
- Owner: sypht-team
- License: apache-2.0
- Created: 2019-09-13T01:53:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-06T18:41:11.000Z (about 2 years ago)
- Last Synced: 2025-04-13T20:14:22.052Z (3 months ago)
- Topics: api-client, data-extraction, document-capture, extract, extract-data-from-pdf, extract-fields, invoice, invoice-parser, node, node-module, nodejs, nodejs-client, pdf-parser, receipt-capture, receipt-reader, receipt-scanner, receipt-scanning, sypht, sypht-api, sypht-node-client
- Language: JavaScript
- Homepage: https://sypht.com
- Size: 62.5 KB
- Stars: 13
- Watchers: 5
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](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 `client_id` and `client_secret`, which can be obtained by registering
for an [account](https://www.sypht.com/signup/developer)
## Prerequisites
* Node.js version 8+.
## Installation
```Bash
npm install sypht-node-client
```
## Usage
Populate system environment variable with the credentials generated above:
```Bash
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:
```javascript
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](https://github.com/sypht-team/sypht-node-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-node-client/blob/master/CODE_OF_CONDUCT.md).