pdffiller-nodejs-api-client (api-v2)
PDFfiller API You can sign up for the API here.
Requirements
- Node.js >= v4 but the latest stable version of NodeJS is recommended;
Installation
npm i pdffiller-nodejs-api-client --save
Quick getting started steps
You can require PDFfiller module as a singleton and use it in anywhere your app, or require constructor and create different instances:
const PDFfiller = PDFfiller; // or const PDFfillerConstructor = PDFfillerConstructor;
Or using ES6:
;
Authentication
Access tokens will automatically initialize when you’re successfully retrieved from the given user's credentials.
The second parameter auto_update
when you set up it as true
token will automatically update when expire
PDFfillerauth ;
When your authorization has been completed successfully you can use client for retrieving, creating, updating or deleting information from your profile.
Also you can set up token, for future request:
PDFfillerauth;
and get current access token:
PDFfillerauth;
Usage
Use a method to retrieve a list of all applications:
PDFfillerapplicationsall ;
Use a method to retrieve an applications by id:
PDFfillerapplications ;
Use a method to create an application:
PDFfillerapplications ;
Use a method to update an application by id:
PDFfillerapplications ;
Use a method to delete an application by id:
PDFfillerapplications ;
Use a method to get application users:
PDFfillerapplications ;
All examples with other endpoints are available in the docs folder.
Working with files
We send request using request-promise library, so to send a file you can just pass a file stream, for example:
const fs = ; PDFfillertemplates ;
When you download files we will return Buffer object after you can save it as in example:
const fs = ; PDFfillertemplates ;
Callback support
Methods provide not only Promise api, you can use callbacks if you want. You can pass callback function to all methods as last argument, in this case methods dont return a Promise:
const fs = ; PDFfillertemplates;
PDFfillerauth;
Support
If you have any problems feel free to contact us:
- On our issues page https://github.com/pdffiller/pdffiller-nodejs-api-client/issues
- Via chat or phone at our tech site https://developers.pdffiller.com
License
This software is licensed under the following MIT license
Contributing
See CONTRIBUTING.
Author
API Team (integrations@pdffiller.com)