HTML to PDF in Java

Overview

This document describes how to convert web pages and HTML documents to PDF in Java using the Pdfcrowd API. The API is easy to use and the integration takes only a couple of lines of code.

Getting Started

Enter a web page or upload an HTML file to get a PDF preview and auto-generated integration code that you can copy and paste to your application.

Or choose from the examples below and adapt the code to your needs.

You can also interactively explore the API in our API Playground.

Installation

Download pdfcrowd-5.3.0-java.zip, unzip it and copy pdfcrowd-5.3.0.jar to your CLASSPATH.

Or learn about other installation options (Maven, GitHub).

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 try out the API without registration using the following demo credentials:
  • Username: demo
  • API key: ce544b6ea52a5621fb9d55f8b542d14d

Or you can start a free trial or purchase the API license to get your personal API credentials.

Examples

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

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

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "example.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // run the conversion and store the result into the "pdf" variable
            byte[] pdf = client.convertUrl("http://www.example.com");

            // at this point the "pdf" variable contains PDF raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("example.pdf");

            // run the conversion and write the result into the output stream
            client.convertUrlToStream("http://www.example.com", outputStream);

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // run the conversion and store the result into the "pdf" variable
            byte[] pdf = client.convertFile("/path/to/MyLayout.html");

            // at this point the "pdf" variable contains PDF raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("MyLayout.pdf");

            // run the conversion and write the result into the output stream
            client.convertFileToStream("/path/to/MyLayout.html", outputStream);

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // run the conversion and write the result to a file
            client.convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // run the conversion and store the result into the "pdf" variable
            byte[] pdf = client.convertString("<html><body><h1>Hello World!</h1></body></html>");

            // at this point the "pdf" variable contains PDF raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("HelloWorld.pdf");

            // run the conversion and write the result into the output stream
            client.convertStringToStream("<html><body><h1>Hello World!</h1></body></html>", outputStream);

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setDebugLog(true);

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.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
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}

Advanced Examples

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

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

            // configure the conversion
            client.setPageSize("Letter");
            client.setOrientation("landscape");
            client.setNoMargins(true);

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "letter_landscape.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setHeaderHeight("15mm");
            client.setFooterHeight("10mm");
            client.setHeaderHtml("<a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>");
            client.setFooterHtml("<center><span class='pdfcrowd-page-number'></span></center>");
            client.setMarginTop("0");
            client.setMarginBottom("0");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "header_footer.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setScaleFactor(300);

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "zoom_300.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setAuthor("Pdfcrowd");
            client.setTitle("Hello World");
            client.setSubject("Demo");
            client.setKeywords("Pdfcrowd,demo");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "with_metadata.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setPageLayout("single-page");
            client.setPageMode("full-screen");
            client.setInitialZoomType("fit-page");
            client.setOrientation("landscape");
            client.setNoMargins(true);

            // run the conversion and write the result to a file
            client.convertUrlToFile("https://pdfcrowd.com/doc/api/", "slide_show.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setElementToConvert("#main");

            // run the conversion and write the result to a file
            client.convertUrlToFile("https://pdfcrowd.com/doc/api/", "html_part.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setCustomJavascript("el=document.createElement('h2'); el.textContent='Hello from Pdfcrowd API'; el.style.color='red'; el_before=document.getElementsByTagName('h1')[0]; el_before.parentNode.insertBefore(el, el_before.nextSibling)");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "html_inject.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setViewportWidth(992);
            client.setRenderingMode("viewport");
            client.setSmartScalingMode("viewport-fit");
            client.setNoMargins(true);

            // run the conversion and write the result to a file
            client.convertUrlToFile("https://getbootstrap.com/", "bootstrap.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;
import java.util.*;
import java.util.zip.*;

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

            // prepare map of local assets
            HashMap<String, File> srcFiles = new HashMap<String, File>();
            srcFiles.put("fonts/OpenSans.ttf", new File("/your-path-to/fonts/OpenSans.ttf"));
            srcFiles.put("images/logo.png", new File("/your-path-to/images/logo.png"));

            // create ZIP archive
            Pdfcrowd.ByteArrayIOStream inStream = new Pdfcrowd.ByteArrayIOStream();
            ZipOutputStream zipOut = new ZipOutputStream(inStream.getOutputStream());

            // add HTML content to the archive
            ZipEntry htmlEntry = new ZipEntry("index.html");
            zipOut.putNextEntry(htmlEntry);
            StringBuilder sb = new StringBuilder();
            sb.append("<html>");
            sb.append("    <head>");
            sb.append("        <style>");
            sb.append("         @font-face");
            sb.append("         {");
            sb.append("             font-family: 'OpenSans';");
            sb.append("             src: url(fonts/OpenSans.ttf) format('truetype');");
            sb.append("         }");
            sb.append("");
            sb.append("         h1");
            sb.append("         {");
            sb.append("             font-family: OpenSans;");
            sb.append("         }");
            sb.append("        </style>");
            sb.append("    </head>");
            sb.append("    <body>");
            sb.append("        <h1>Hello World</h1>");
            sb.append("        <img src='images/logo.png'>");
            sb.append("    </body>");
            sb.append("</html>");
            byte[] htmlBytes = sb.toString().getBytes();
            zipOut.write(htmlBytes, 0, htmlBytes.length);

            // add required local files to the archive
            for(Map.Entry<String, File> entry : srcFiles.entrySet()) {
                FileInputStream fis = new FileInputStream(entry.getValue());
                ZipEntry zipEntry = new ZipEntry(entry.getKey());
                zipOut.putNextEntry(zipEntry);

                byte[] bytes = new byte[1024];
                int length;
                while((length = fis.read(bytes)) != -1) {
                    zipOut.write(bytes, 0, length);
                }
                fis.close();
            }

            zipOut.close();

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("HelloFromZip.pdf");

            // run the conversion and write the result into the output stream
            client.convertStreamToStream(inStream, outputStream);

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setCustomJavascript("libPdfcrowd.highlightHtmlElements({backgroundColor: 'rgba(255, 191, 0, 0.1)', borderColor:null})");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "highlight_background.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

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

            // configure the conversion
            client.setCustomJavascript("libPdfcrowd.highlightHtmlElements({borderColor: 'orange', backgroundColor: null, padding: '4px', margin: '4px'})");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "highlight_borders.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}

Integration Examples

The API can be easily integrated into your environment. You can have our interactive API Playground autogenerate the integration code for you:

You can also check out a complete example in our pdfcrowd-examples Github repository:

Common Customizations

The API lets you convert a web page, a local HTML file, or a string containing HTML. The result of the conversion can be stored to a local file, to a stream object or to a variable. See the conversion input section for more details.

The best way to start with the API is to choose one of the examples and once you get it working, you can further customize the code. You can find the most common customizations in the table below.

Page size Change the page size with setPageSize or setPageDimensions . Pass -1 to setPageHeight to get a single page PDF containing the whole document.
Page orientation Change the page orientation to landscape with setOrientation.
Page margins Adjust the page margins with setPageMargins.
Headers and footers Add headers and footers with setHeaderHtml and setFooterHtml. Set the height with setFooterHeight and setHeaderHeight.
Zoom Scale the HTML contents with setScaleFactor.
Hide or remove elements You can use the following classes in your HTML code to hide or remove elements from the output:
  • pdfcrowd-remove - sets display:none!important on the element
  • pdfcrowd-hide - sets visibility:hidden!important on the element
Use @media print You can switch to the print version of the page (if it exists) with setUsePrintMedia.
Force page break You can force a page break with
<div style="page-break-before:always"></div>
Avoid page break You can avoid a page break inside an element with the following CSS
th, td, img { page-break-inside:avoid }
Run custom JavaScript You can use setOnLoadJavascript or setCustomJavascript to alter the HTML contents with a custom JavaScript. In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library .
Custom CSS styling You can alter CSS styling used during conversion with a custom JavaScript or using the pdfcrowd-body CSS class, which is automatically set on the HTML <body> element. You can, for example, set the H1 height to 48px by adding the following line to your CSS:
.pdfcrowd-body h1 { font-size: 48px; }

Template Rendering

The API enables rendering of HTML templates. The template syntax is based on the Jinja template rendering engine.

The most common constructs are:

  • Data rendering: Invoice: {{ invoice.number }}
  • For loop: {% for invoice in invoices %} ... {% endfor %}
  • If statement: {% if invoice.total > 100 %} ... {% endif %}
  • Data filter: {{ invoice.to.first_name|capitalize }}

The supported input data formats are JSON, XML, CSV and YAML. The data can be uploaded from a file or from a string variable.

Supported template filters: capitalize, center, default, escape, first, forceescape, format, indent, join, last, length, list, lower, replace, reverse, safe, slice, sort, string, striptags, title, trim, truncate, unique, upper, wordcount, wordwrap.

Template Rendering Examples

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

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToPdfClient client =
                new Pdfcrowd.HtmlToPdfClient("{{ user_name }}", "{{ api_key }}");

            // configure the conversion
            client.setDataString("{\n" +
                "    \"name\": \"World\",\n" +
                "    \"product\": \"Pdfcrowd API\"\n" +
                "}");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToPdfClient client =
                new Pdfcrowd.HtmlToPdfClient("{{ user_name }}", "{{ api_key }}");

            // configure the conversion
            client.setDataString("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
                "<data>\n" +
                "  <name>World</name>\n" +
                "  <product>Pdfcrowd API</product>\n" +
                "</data>");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToPdfClient client =
                new Pdfcrowd.HtmlToPdfClient("{{ user_name }}", "{{ api_key }}");

            // configure the conversion
            client.setDataString("name: World\n" +
                "product: Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}
import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToPdfClient client =
                new Pdfcrowd.HtmlToPdfClient("{{ user_name }}", "{{ api_key }}");

            // configure the conversion
            client.setDataString("name,product\n" +
                "World,Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            // report the error
            System.err.println("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
        catch(IOException why) {
            // report the error
            System.err.println("IO Error: " + why);

            // rethrow or handle the exception
            throw why;
        }
    }
}

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 in your way
}

Troubleshooting

API Method Reference

Refer for details to the API Method Reference.