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

PDF to PDF - Java SDK

Installation

You can download pdfcrowd-4.2.1-java.zip, unzip it and copy pdfcrowd-4.2.1.jar to your CLASSPATH.

You can learn more install options (Maven, GitHub) 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

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

public class ApiTest {
    public static void main(String[] args) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

Join 4 local PDF files together to in-memory PDF

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

public class ApiTest {
    public static void main(String[] args) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // create output file for conversion result
            FileOutputStream output_file = new FileOutputStream("offer.pdf");

            // run the conversion and store the result into a pdf variable
            byte[] pdf = client.convert();

            // write the pdf the into the output file
            output_file.write(pdf);

            // close the output file
            output_file.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

Join 4 local PDF files together and write the resulting PDF to an output stream

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

public class ApiTest {
    public static void main(String[] args) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // create output stream for conversion result
            FileOutputStream output_stream = new FileOutputStream("offer.pdf");

            // run the conversion and write the result into the output stream
            client.convertToStream(output_stream);

            // close the output stream
            output_stream.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

Join In-Memory PDFs

Join 4 in-memory PDFs together to a PDF file

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) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/cover.pdf")));
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/proposal.pdf")));
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/price.pdf")));
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/contact.pdf")));

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

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

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) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/cover.pdf")));
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/price.pdf")));
            client.addPdfFile("/path/to/contact.pdf");

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

Conversion Info

Get info about the current conversion

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) {
        try {
            // create the API client instance
            Pdfcrowd.PdfToPdfClient client = new Pdfcrowd.PdfToPdfClient("username", "apikey");

            // configure the conversion
            client.setDebugLog(true);
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/cover.pdf")));
            client.addPdfRawData(Files.readAllBytes(Paths.get("/path/to/proposal.pdf")));

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
            
            // print URL to the debug log
            System.out.println("Debug log url: " + client.getDebugLogUrl());
            
            // print the number of available conversion credits in your account
            System.out.println("Remaining credit count: " + client.getRemainingCreditCount());
            
            // print the number of credits consumed by the conversion
            System.out.println("Consumed credit count: " + client.getConsumedCreditCount());
            
            // print the unique ID of the conversion
            System.out.println("Job id: " + client.getJobId());
            
            // print the total number of pages in the output document
            System.out.println("Page count: " + client.getPageCount());
            
            // print the size of the output in bytes
            System.out.println("Output size: " + client.getOutputSize());
        }
        catch(Pdfcrowd.Error why) {
            // report the error to the standard error stream
            System.err.println("Pdfcrowd Error: " + why);
        }
        catch(IOException why) {
            // report the error to the standard error stream
            System.err.println("IO Error: " + why.getMessage());
        }
    }
}

API Reference - class PdfToPdfClient

Conversion from PDF to PDF.

Constructor

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

 

PDF Manipulation

public PdfToPdfClient setAction(String 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.
public byte[] convert()
Perform an action on the input files.
Returns
  • byte[] - Byte array containing the output PDF.
public void convertToStream(OutputStream outStream)
Perform an action on the input files and write the output PDF to an output stream.
Parameter Description Default
outStream
The output stream that will contain the output PDF.
public void convertToFile(String filePath) throws IOException
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.
public PdfToPdfClient addPdfFile(String 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.
public PdfToPdfClient addPdfRawData(byte[] 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

public PdfToPdfClient setDebugLog(boolean debugLog)
Turn on the debug logging.
Parameter Description Default
debugLog
Set to true to enable the debug logging.
false
Returns
  • PdfToPdfClient - The converter object.
public String getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • String - The link to the debug log.
public int 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.
public int getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
public String getJobId()
Get the job id.
Returns
  • String - The unique job identifier.
public int getPageCount()
Get the total number of pages in the output document.
Returns
  • int - The page count.
public int getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.

 

API Client Options

public PdfToPdfClient setUseHttp(boolean 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.
public PdfToPdfClient setUserAgent(String 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_java_client/4.2.1 (http://pdfcrowd.com)
Returns
  • PdfToPdfClient - The converter object.
public PdfToPdfClient setProxy(String host, int port, String userName, String 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.
public PdfToPdfClient setRetryCount(int 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(Pdfcrowd.Error why) {
    // print error
    System.err.println("Pdfcrowd Error: " + why);

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

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

    // or handle the error by your way
}