Giter VIP home page Giter VIP logo

pdf-tools's Introduction

PDF Tools

The content of this repository is the source code of the PDF-Tools API.

In one of my projects I had the need to encrypt some PDF files with passwords and, I noticed that all APIs for this are currently paid. So I developed my own open-source.

If you are interested in improving the API, your pull request is welcome.

Getting Started

Route Method Description
/encrypt POST Encrypt one or more PDFs with a password and downloads a ZIP file.

Actions

Encrypt

Receive a post request with the following form-data:

Key Type Required Description
files Array (of files) Yes An array with PDF files to be encrypted
password String Yes The password to be applied to each of these PDFs

Handling Errors

Code Description
ZIP_ERROR Error zipping the response.
ENCRYPT_ERROR Error encrypting the PDFs
PASSWORD_NOT_FOUND Password not found in the API request
FILES_NOT_FOUND PDF files not found in the API request

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Remember to use the default nomenclature for commits, using npm run commit or yarn commit.

Please make sure to update tests as appropriate.

pdf-tools's People

Watchers

Ighor Redhd avatar

Forkers

jeffgm

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.