Skip to main content

Tasks Roadmap


Knowing where to begin when using the DynamicPDF API can be confusing. Use this page to help you know where to start.
tip

If this is your first time here be certain to see Getting Started for an overview of the DynamicPDF API.

Create a new PDF report using dynamic data.

Use the DynamicPDF Designer to create rich and complex reports. Create the report using Designer, test the generated report, and then use the dlex-layout or pdf endpoint to use the report in production.

Convert a Word document to a PDF.

Use the pdf endpoint and in the instructions JSON specify a word input to convert the Word document to a PDF.

Convert an HTML document to a PDF.

Use the pdf endpoint and in the instructions JSON specify an html input to convert the HTML document or document fragment to a PDF.

info

HTML to PDF conversion supports CSS, refer to the following blog post for example: Using CSS Stylesheet when processing HTML.

Convert an Image to a PDF.

Use the pdf endpoint and in the instructions JSON specify a image input to convert an image to a PDF.

Add a cover-page to an existing PDF.

Use the pdf endpoint and in the instructions JSON specify a page input to create the cover page. Alternatively, if you prefer to use Designer, then you can graphically create a cover page.

Overlay new elements over an existing PDF.

Use the pdf endpoint combined with instructions JSON specifying one or more templates to apply to any input type when processing/merging the available inputs.

Programmatically complete a pre-existing form.

Use the pdf endpoint to complete a pre-existing form. Or use Designer to graphically fill-out a form.

Programmatically remove form elements from a pre-existing form.

Use the pdf endpoint to flatten or remove form fields from a pre-completed form.

Convert and merge different file types into a combined PDF.

Use the pdf endpoint to merge PDFs, images, Word documents, and images into a combined PDF.

Extract text from a PDF.

Use the pdf-text endpoint to programmatically extract text from a PDF and return the text as a JSON document.

Extract a PDF's metadata.

Use the pdf-info endpoint to extract PDF metadata or use the pdf-xmp endpoint to extract XMP metadata.

Reuse an existing PDF report with dynamic data.

When using Designer you can reuse your existing PDF report template. Before developing a new DLEX using Designer, instead of building a new report from scratch, consider using a starting PDF template.

Delete pages from a PDF.

Deleting pages from a PDF uses the pdf endpoint combined with one or more pdf inputs specified in an instructions document.

info

"Deleting" is merging one or more copies of the same PDF and only including specified pages when merging the copies to form a new PDF. For example, merging pages 1-3 of a ten page PDF and then merging pages 5-7 or the same PDF excludes pages 4 and pages 8-10 when creating the new PDF.

Add an outline to a PDF or reuse an existing outline when creating a new PDF.

Adding bookmarks/outline to a PDF uses the pdf endpoint combined with one or more inputs from an instructions document. All inputs can have a bookmark or outline associated with it.

Split a PDF into multiple PDFs.

Splitting a PDF into multiple PDFs is similar to deleting pages from a PDF only use the pdf endpoint multiple times to split the PDF into multiple PDFs. Each time the pdf endpoint is called only the relevant pages are extracted from the source PDF, thus splitting the PDF.