paper-handler v1.0.2

paper-handler-module

Official paper-handler API for nodeJS

Installation :

The package is available on npm :

npm i -S paper-handler

How to use paper-handler API ?

Get permissions :

/* example of options to ask for permissions */
const options = {
    type : "EDIT", /* Or "READ"*/
    topics : ["school"], /* topics for which you want the permission */
    users : ["example@test.com","example2@test.com"] /* users for which you want to have the permission */
}


/* ask for permission */
ph.askForPermission("YOUR_DEVELOPER_KEY", options)
    .then((response)=>{
        /* handle the success result */
        console.log(response);
    })
    .catch((error)=>{
        /* handle the error */
        console.log(error);
    });

Get a file :

/* example of options necessary to request for a file or tu put one */
const fileOptions = {
    topic : "electricity",
    year : "2017",
    month : "March",
    target : "example@test.com"
};


/**
 * Example to get a file from paper-handler server.
 * (Transaction authorized only if you have the correct permissions)
 */

ph.getFile("YOUR_DEVELOPER_KEY",fileOptions)
    .then((readStream)=>{
        /* transaction has been authorized*/

        var writeStream = fs.createWriteStream('example.pdf');
        /* pipe your writeStream to response readStream to get the file*/
        readStream.pipe(writeStream);

    })
    .catch((error)=>{
        /* handle error*/
        console.log(error.message);
    });

Put a file :

/* example of options necessary to request for a file or tu put one */
const fileOptions = {
    topic : "electricity",
    year : "2017",
    month : "March",
    target : "example@test.com"
};

/**
 * Example to put a file on the server for a user
 * (Works only if you have necessary permissions)
 */

var readStream = fs.createReadStream('myPdf.pdf');
ph.putFile("YOUR_DEVELOPER_KEY",fileOptions,readStream,'test.pdf')
    .then((response)=>{
        /* the file has been put successfully */
        console.log(response);
    })
    .catch((error)=>{
        /* Something wrong happened*/
        console.log(error);
    });

If you have any question, do not hesitate to ask via contact form Paperhandler.