Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

PDF to PDF - Node.js SDK

Installation

You can install the client library from npm
npm install pdfcrowd

You can learn more install options here.

The API client library si common for all Pdfcrowd converters.

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key. You can find the API key in your account page.

Getting Started

Join PDF Files

Join 4 local PDF files together to a PDF file

var pdfcrowd = require("pdfcrowd");

// create the API client instance
var client = new pdfcrowd.PdfToPdfClient("username", "apikey");

// configure the conversion
try {
    client.addPdfFile("/path/to/cover.pdf");
    client.addPdfFile("/path/to/proposal.pdf");
    client.addPdfFile("/path/to/price.pdf");
    client.addPdfFile("/path/to/contact.pdf");
} catch(why) {
    console.error("Pdfcrowd Error: " + why);
    console.error("Pdfcrowd Error Code: " + why.getCode());
    console.error("Pdfcrowd Error Message: " + why.getMessage());
    process.exit(1);
}

// run the conversion and write the result to a file
client.convertToFile(
    "offer.pdf",
    function(err, fileName) {
        if (err) return console.error("Pdfcrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

Join 4 local PDF files together to a PDF file via custom callbacks

var pdfcrowd = require("pdfcrowd");

// create the API client instance
var client = new pdfcrowd.PdfToPdfClient("username", "apikey");

// configure the conversion
try {
    client.addPdfFile("/path/to/cover.pdf");
    client.addPdfFile("/path/to/proposal.pdf");
    client.addPdfFile("/path/to/price.pdf");
    client.addPdfFile("/path/to/contact.pdf");
} catch(why) {
    console.error("Pdfcrowd Error: " + why);
    console.error("Pdfcrowd Error Code: " + why.getCode());
    console.error("Pdfcrowd Error Message: " + why.getMessage());
    process.exit(1);
}

// use predefined callback for saving to a file
var callbacks = pdfcrowd.saveToFile("offer.pdf");

// set custom error callback
callbacks.error = function(errMessage, statusCode) {
    if(statusCode) {
        console.error("Pdfcrowd Error: " + statusCode + " - " + errMessage);
    } else {
        console.error("Pdfcrowd Error: " + errMessage);
    }
};

// run the conversion and write the result to a file
client.convert(callbacks);

Join In-Memory PDFs

Join 4 in-memory PDFs together to a PDF file

var pdfcrowd = require("pdfcrowd");
var fs = require("fs");

// create the API client instance
var client = new pdfcrowd.PdfToPdfClient("username", "apikey");

// configure the conversion
try {
    client.addPdfRawData(fs.readFileSync("/path/to/cover.pdf"));
    client.addPdfRawData(fs.readFileSync("/path/to/proposal.pdf"));
    client.addPdfRawData(fs.readFileSync("/path/to/price.pdf"));
    client.addPdfRawData(fs.readFileSync("/path/to/contact.pdf"));
} catch(why) {
    console.error("Pdfcrowd Error: " + why);
    console.error("Pdfcrowd Error Code: " + why.getCode());
    console.error("Pdfcrowd Error Message: " + why.getMessage());
    process.exit(1);
}

// run the conversion and write the result to a file
client.convertToFile(
    "offer.pdf",
    function(err, fileName) {
        if (err) return console.error("Pdfcrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

Join 2 in-memory PDFs together with 2 local PDF files to a PDF file

var pdfcrowd = require("pdfcrowd");
var fs = require("fs");

// create the API client instance
var client = new pdfcrowd.PdfToPdfClient("username", "apikey");

// configure the conversion
try {
    client.addPdfRawData(fs.readFileSync("/path/to/cover.pdf"));
    client.addPdfFile("/path/to/proposal.pdf");
    client.addPdfRawData(fs.readFileSync("/path/to/price.pdf"));
    client.addPdfFile("/path/to/contact.pdf");
} catch(why) {
    console.error("Pdfcrowd Error: " + why);
    console.error("Pdfcrowd Error Code: " + why.getCode());
    console.error("Pdfcrowd Error Message: " + why.getMessage());
    process.exit(1);
}

// run the conversion and write the result to a file
client.convertToFile(
    "offer.pdf",
    function(err, fileName) {
        if (err) return console.error("Pdfcrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

Conversion Info

Get info about the current conversion

var pdfcrowd = require("pdfcrowd");
var fs = require("fs");

// create the API client instance
var client = new pdfcrowd.PdfToPdfClient("username", "apikey");

// configure the conversion
try {
    client.setDebugLog(true);
    client.addPdfRawData(fs.readFileSync("/path/to/cover.pdf"));
    client.addPdfRawData(fs.readFileSync("/path/to/proposal.pdf"));
} catch(why) {
    console.error("Pdfcrowd Error: " + why);
    console.error("Pdfcrowd Error Code: " + why.getCode());
    console.error("Pdfcrowd Error Message: " + why.getMessage());
    process.exit(1);
}

// run the conversion and write the result to a file
client.convertToFile(
    "offer.pdf",
    function(err, fileName) {
        if (err) return console.error("Pdfcrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
        
        // print URL to the debug log
        console.log("Debug log url: " + client.getDebugLogUrl());
        
        // print the number of available conversion credits in your account
        console.log("Remaining credit count: " + client.getRemainingCreditCount());
        
        // print the number of credits consumed by the conversion
        console.log("Consumed credit count: " + client.getConsumedCreditCount());
        
        // print the unique ID of the conversion
        console.log("Job id: " + client.getJobId());
        
        // print the total number of pages in the output document
        console.log("Page count: " + client.getPageCount());
        
        // print the size of the output in bytes
        console.log("Output size: " + client.getOutputSize());
    });

API Reference - class PdfToPdfClient

Conversion from PDF to PDF.

Constructor

function PdfToPdfClient(userName, apiKey)
Constructor for the Pdfcrowd API client.
Parameter Description Default
userName
Your username at Pdfcrowd.
apiKey
Your API key.

 

PDF Manipulation

function setAction(action)
Specifies the action to be performed on the input PDFs.
Parameter Description Default
action
Allowed values:
  • join
    Concatenate input PDFs into a single one.
  • shuffle
    Collate pages from input PDFs into a single one, take one page at a time from each input PDF. This is useful when combining two scanned documents containing odd and even pages.
join
Returns
  • PdfToPdfClient - The converter object.
function convert(callbacks)
Perform an action on the input files.
Parameter Description Default
callbacks
The object that defines the following functions:
  • data(readStream) - called when the output data can be read from readStream
  • error(message, statusCode) - called when an error occurs
  • end() - called when the conversion finishes
The client library provides 2 helper functions that can be used here:
  • saveToFile(filePath[, callback]) - saves the output data to a file
    • filePath - the output file path
    • callback(err, filePath) - called when the conversion finishes
  • sendPdfInHttpResponse(response[, fileName, disposition]) - sends the generated PDF in an HTTP response
    • response - the response object
    • fileName - the desired file name
    • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".
Returns
  • PdfToPdfClient - The converter object.
function convertToFile(filePath, callback)
Perform an action on the input files and write the output PDF to a file.
Parameter Description Default
filePath
The output file path.
The string must not be empty.
callback
The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.
function addPdfFile(filePath)
Add a PDF file to the list of the input PDFs.
Parameter Description Default
filePath
The file path to a local PDF file.
The file must exist and not be empty.
Returns
  • PdfToPdfClient - The converter object.
function addPdfRawData(pdfRawData)
Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another Pdfcrowd converter.

Example in PHP:
$clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl('http://www.example.com'));
Parameter Description Default
pdfRawData
The raw PDF data.
The input data must be PDF content.
Returns
  • PdfToPdfClient - The converter object.

 

Miscellaneous

function setDebugLog(debugLog)
Turn on the debug logging.
Parameter Description Default
debugLog
Set to true to enable the debug logging.
false
Returns
  • PdfToPdfClient - The converter object.
function getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
function getRemainingCreditCount()
Get the number of conversion credits available in your account.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
Returns
  • int - The number of credits.
function getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
function getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
function getPageCount()
Get the total number of pages in the output document.
Returns
  • int - The page count.
function getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.

 

API Client Options

function setUseHttp(useHttp)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Parameter Description Default
useHttp
Set to true to use HTTP.
false
Returns
  • PdfToPdfClient - The converter object.
function setUserAgent(userAgent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
Parameter Description Default
userAgent
The user agent string.
pdfcrowd_nodejs_client/4.2.0 (http://pdfcrowd.com)
Returns
  • PdfToPdfClient - The converter object.
function setProxy(host, port, userName, password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
Parameter Description Default
host
The proxy hostname.
port
The proxy port.
userName
The username.
password
The password.
Returns
  • PdfToPdfClient - The converter object.
function setRetryCount(retryCount)
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
Parameter Description Default
retryCount
Number of retries wanted.
1
Returns
  • PdfToPdfClient - The converter object.

 

Error Handling

try {
    // call the API 
}
catch(why) {
    // print error
    console.error("Pdfcrowd Error: " + why);

    // print just error code
    console.error("Pdfcrowd Error Code: " + why.getCode());

    // print just error message
    console.error("Pdfcrowd Error Message: " + why.getMessage());

    // or handle the error by your way
}