{"id":20502591,"url":"https://github.com/sypht-team/sypht-node-client","last_synced_at":"2025-04-13T20:14:26.954Z","repository":{"id":35362015,"uuid":"208177994","full_name":"sypht-team/sypht-node-client","owner":"sypht-team","description":"A Nodejs client for the Sypht API","archived":false,"fork":false,"pushed_at":"2023-05-06T18:41:11.000Z","size":64,"stargazers_count":13,"open_issues_count":4,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-13T20:14:22.052Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://sypht.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sypht-team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-13T01:53:28.000Z","updated_at":"2023-12-06T06:12:54.000Z","dependencies_parsed_at":"2022-08-08T07:16:26.836Z","dependency_job_id":null,"html_url":"https://github.com/sypht-team/sypht-node-client","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-node-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-node-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-node-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-node-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sypht-team","download_url":"https://codeload.github.com/sypht-team/sypht-node-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248774968,"owners_count":21159534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-11-15T19:24:08.657Z","updated_at":"2025-04-13T20:14:26.928Z","avatar_url":"https://github.com/sypht-team.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sypht Nodejs Client\nThis repository is a Nodejs reference client implementation for working with the Sypht API at https://api.sypht.com.\n\n## About Sypht\n[Sypht](https://sypht.com) is a SaaS [API]((https://docs.sypht.com/)) which extracts key fields from documents. For \nexample, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number \nand biller information. \n\n## Getting started\nTo get started you'll need API credentials, i.e. a `client_id` and `client_secret`, which can be obtained by registering\nfor an [account](https://www.sypht.com/signup/developer)\n\n## Prerequisites\n* Node.js version 8+.\n\n## Installation\n\n```Bash\nnpm install sypht-node-client\n```\n\n\n## Usage\nPopulate system environment variable with the credentials generated above:\n\n```Bash\nSYPHT_API_KEY=\"$client_id:$client_secret\"\nSYPHT_AUTH_ENDPOINT=\"https://auth.sypht.com/oauth2/token\"\n# use https://login.sypht.com/oauth/token for legacy keys\n```\n\nthen invoke the client with a file of your choice:\n```javascript\nvar sypht = require('sypht-node-client');\n\nasync function main () {\n    var data = await sypht.fileUpload(['sypht.invoice', 'sypht.document'], './sample_invoice.pdf');\n    data = await sypht.fetchResults(data['fileId']);\n    console.log(JSON.stringify(data, null, 2));\n} \n\n```\n\n## License\nThe 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).\n\n## Code of Conduct\nEveryone 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsypht-team%2Fsypht-node-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsypht-team%2Fsypht-node-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsypht-team%2Fsypht-node-client/lists"}