PDF to Image / Node.js Guide

Overview

This page serves as a guide for using the PDFCrowd API to convert PDF into images in Node.js applications.

npm install pdfcrowd

git clone https://github.com/pdfcrowd/pdfcrowd-nodejs
cd pdfcrowd-nodejs
npm link

Quick Start

Below are Node.js examples to help you quickly get started with the API. Explore our additional examples for more insights.

For a multi-page PDF, the API returns a ZIP archive containing an image for each page. For a single-page PDF, the output is directly an image (e.g., PNG). To determine the output format, use isZippedOutput(). You can enforce the use of a ZIP archive by using setForceZip().

var pdfcrowd = require("pdfcrowd");

// Create an API client instance.
var client = new pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

try {
    // If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png");
    client.setForceZip(true);
} catch(why) {
    // Report the error.
    console.error("PDFCrowd Error: " + why);
    process.exit(1);
}

// Run the conversion and save the result to a file.
client.convertFileToFile(
    "/path/to/invoice.pdf",
    "invoice.zip",
    function(err, fileName) {
        if (err) return console.error("PDFCrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

var pdfcrowd = require("pdfcrowd");

// Create an API client instance.
var client = new pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

try {
    // If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png");
    client.setForceZip(true);
} catch(why) {
    // Report the error.
    console.error("PDFCrowd Error: " + why);
    process.exit(1);
}

// Run the conversion and save the result to a file.
client.convertUrlToFile(
    "https://pdfcrowd.com/static/pdf/apisamples/invoice.pdf",
    "invoice.zip",
    function(err, fileName) {
        if (err) return console.error("PDFCrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

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

// Create an API client instance.
var client = new pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

try {
    // If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png");
    client.setForceZip(true);
} catch(why) {
    // Report the error.
    console.error("PDFCrowd Error: " + why);
    process.exit(1);
}

// Run the conversion and save the result to a file.
client.convertRawDataToFile(
    fs.readFileSync("/path/to/hello_world.pdf"),
    "invoice.zip",
    function(err, fileName) {
        if (err) return console.error("PDFCrowd Error: " + err);
        console.log("Success: the file was created " + fileName);
    });

Authentication

To access the API, you will need to use your PDFCrowd username and API key. For initial testing, you may use the following demo credentials without registering:

• Username: demo
• API key: ce544b6ea52a5621fb9d55f8b542d14d

To obtain your personal API credentials, start a free trial or purchase the API license.

Error Handling

It is recommended that you implement error handling to catch errors the API may return. Effective error handling is vital as it ensures application stability and provides clearer diagnostics. See the example code below for guidance on implementing error handling, and refer to this list of status codes for more information.

try {
    // Call the API 
}
catch(why) {
    // Log the complete error
    console.error("PDFCrowd Error: " + why);

    // Log the HTTP status code
    console.error("Status Code: " + why.getStatusCode());

    // Log the reason code
    console.error("Reason Code: " + why.getReasonCode());

    // Log the error message
    console.error("Error Message: " + why.getMessage());

    // Log the documentation link
    console.error("Documentation Link: " + why.getDocumentationLink());
}

Troubleshooting

• If you are receiving an error, refer to the API Status Codes for more information.
• Use setDebugLog() and getDebugLogUrl() to obtain detailed information about the conversion process, including load errors, load times, browser console output, etc.
• Consult the FAQ for answers to common questions.
• Contact us if you need assistance or if there is a feature you are missing.

API Method Reference

Refer to the PDF to Image Node.js Reference for a description of all API methods.