PDF to Image / Java Guide

Overview

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

<dependency>
  <groupId>com.pdfcrowd</groupId>
  <artifactId>pdfcrowd</artifactId>
  <version>6.3.0</version>
  <scope>compile</scope>
</dependency>

compile 'com.pdfcrowd:pdfcrowd:6.3.0'

git clone https://github.com/pdfcrowd/pdfcrowd-java
cd pdfcrowd-java
mvn install

Quick Start

Below are Java 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().

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // Create an API client instance.
            Pdfcrowd.PdfToImageClient client =
                new Pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // If unsure whether the input is a single-page file, enforce ZIP output.
            client.setOutputFormat("png");
            client.setForceZip(true);

            // Run the conversion and save the result to a file.
            client.convertFileToFile("/path/to/invoice.pdf", "invoice.zip");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // Create an API client instance.
            Pdfcrowd.PdfToImageClient client =
                new Pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // If unsure whether the input is a single-page file, enforce ZIP output.
            client.setOutputFormat("png");
            client.setForceZip(true);

            // Run the conversion and save the result to a file.
            client.convertUrlToFile("https://pdfcrowd.com/static/pdf/apisamples/invoice.pdf", "invoice.zip");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

import com.pdfcrowd.*;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Paths;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // Create an API client instance.
            Pdfcrowd.PdfToImageClient client =
                new Pdfcrowd.PdfToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // If unsure whether the input is a single-page file, enforce ZIP output.
            client.setOutputFormat("png");
            client.setForceZip(true);

            // Run the conversion and save the result to a file.
            client.convertRawDataToFile(Files.readAllBytes(Paths.get("/path/to/hello_world.pdf")), "invoice.zip");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

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(Pdfcrowd.Error why) {
    // print the error
    System.err.println("Pdfcrowd Error: " + why);

    // print the error code
    System.err.println("Pdfcrowd Error Code: " + why.getCode());

    // print the error message
    System.err.println("Pdfcrowd Error Message: " + why.getMessage());
}

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 Java Reference for a description of all API methods.