Skip to main content

· 5 min read
James A. Brannan

The DynamicPDF Client libraries make using the DynamicPDF Cloud API a breeze. We have Node.js, .NET, Java, PHP, and Go client libraries. But sometimes, you might want to call the DynamicPDF Cloud API directly as a REST call to your project without using any coding. In this blog post, we use the API to call the dlex-layout endpoint directly as a REST call with no coding.


The instructions below, although particular to also apply to other online no-code platforms such as Retool, WaveMaker, Betty Blocks, DronaHQ, and others.

The allows developer to create interactive websites and APIs using no coding. To use register for free account.


This post does not provide a introduction or discuss integrating your plugin into an app, only how to create the plugin. For using plugins, refer to the documentation.

Also, if you do not have a DynamicPDF Cloud API account, register for a free account here. Both offer free accounts and allow you to upgrade as needed seamlessly. Refer to the numerous examples and documentation (Getting Started).

Refer to the documentation for complete documentation on creating and using an API; here, we illustrate using the Add another call button to add a call to your API.

Creating a New Plugin

The first step in creating a new plugin is to navigate to the Plugins page and create a new one (figure 1).

  1. Click on the Plugins tab to be taken to the Plugins screen.
  2. Click the Create a plugin button to create a new plugin.

Figure 1. Creating a new plugin.

  1. Name the new plugin DynamicPDF Endpoint Example then click Create plugin.

Figure 2. Naming the plugin.

Creating the Plugin

After initially creating a new plugin it takes you to the details screen for creating the plugin (figure 3).

  1. Add an image as your logo. I chose the DynamicPDF CloudAPI logo.
  2. Add an endpoint description to the Description field.
  3. Select a category for the plugin (I chose Technical).

Figure 3. Describing the plugin.

Plugin API Calls

After describing the plugin you create the plugin details by completing the Plugin API Calls tab (figure 4).

  1. Select the API calls tab to be taken to the Plugin API Calls screen.
  2. Assign a name to the API Name.
  3. Select Add another call to expand and show the fields needed to define the API call.

Figure 4. Creating the Call.

After selecting Add another call, the screen adds more fields to enter the call's details (figure 5).

  1. Assign a name for the call (here dlex-layout-call). Select Data from the Use as dropdown and select File from the Data type dropdown.
  2. Select POST and add the URL to the REST call (https::// .
  3. Click Add header to add a new header.
  4. Assign Authorization as the Key and write Bearer for the value.

Now you must get the authorization key from your DynamicPDF account.

  1. Go to your DynamicPDF CloudAPI account and select Apps and API Keys.
  2. Copy your API key by clicking [copy].
  3. Paste the value to the field after Bearer, the complete value is Bearer *your api key value*.

Figure 5. Add your API key as a header parameter.

After creating a header and adding your API key, you create a form field for the path to your DLEX file.


Here the DLEX file is in your DynamicPDF Cloud Storage and you use the relative path in DynamicPDF CloudAPI.

  1. Click Add parameter to create a new parameter.
  2. Select Form-data as the Body type.
  3. Assign DlexPath as the Key.
  4. Navigate to your DynamicPDF account and select Manage Resources.
  5. Navigate to the dlex-layout folder in the samples folder, highlight the file path, right-click, and select Copy File Path to copy the file path to your clipboard.
  6. Paste the value for the parameter in the Value field.

Figure 6. Adding the DlexPath to the call.

After adding the API key and the DlexPath, add the path to the layout data (figure 7).


You layout data is your organization's private data, although nothing prevents you from storing it in the DynamicPDF CloudAPI's Cloud Storage, here we envision it is stored in your local system.

  1. Click Add parameter to add another parameter.
  2. Assign LayoutData as the Key.
  3. Check the Send file checkbox.
  4. Click Upload to open a file dialog.
  5. Select the file to upload the layout data (SimpleReportWithCoverPage.json).

Figure 7. Adding the LayoutData to the call.

  1. Click Reinitialize call to reinitialize it.
  2. Click to preview the call.

Figure 8. Initializing and previewing the API call.

After clicking the preview link, your newly created API calls the dlex-layout endpoint and opens the created PDF in a new browser tab (figure 9).

Figure 9. Previewing the dlex-layout API call's resultant PDF.


Upon clicking the Plugins tab, you will see your newly created API listed (figure 10). You can edit the API and when satisfied, you can register it so that others can use the API or you can use it privately in your own applications. Refer to the documentation for more information on using your API.

Figure 10. Your newly created plugin.

Although using the DynamicPDF CloudAPI with one of it's client libraries is the most robust way to use the CloudAPI, it is also easily integrated into one of the available codeless development tools available on the web.

· One min read
James A. Brannan
Example banner

The Go programming language client library is now available. Download the client library's source from GitHub. Also, check out the new examples on GitHub illustrating how to use this library with the Cloud API.

Client libraries make using the DynamicPDF Cloud API a breeze. We already have client libraries written in Node.js, .NET, Java, and PHP. And now we have a fifth client library, Go. Get started using Go today!

· One min read
James A Brannan

We here at the DynamicPDF Cloud API are excited to announce that the DynamicPDF Cloud API can now convert HTML to PDF. With the addition of a new input type to the pdf endpoint, you can easily convert HTML pages to PDF documents. And you can specify raw HTML or a file path in your local storage system or in the DynamicPDF Cloud Storage. And we updated all client libraries to support HTML conversion. The HTML input type can also be mixed with other input types such as PDF, image, DLEX and page to create PDF documents with pages from multiple sources.

· One min read
Andrew Cochran

We've been busy here at DynamicPDF. We've just about completed BETA testing on a new HTML to PDF feature of the Cloud API. We expect it to be released in January 2023.

We're also working on a new PDF rasterization feature. This will make it possible to convert PDF documents to images. BETA testing will begin shortly, and we expect this to be released in 2023.

Happy Holidays!

· One min read
James A. Brannan

We at DynamicPDF are happy to announce the following tutorials, now available online. These tutorials illustrate how to use DynamicPDF Designer to create rich, dynamic PDF reports.

Designer - Quick Tour
Create a Page
Create a Report
Create a Sub Report
Create a Page Using a Template
Create a Report Using a Template
Use a Report using the dlex-layout Endpoint

Learn how to use the DynamicPDF Cloud API's Designer today by completing the Designer reports.

· One min read
James A. Brannan

We at DynamicPDF are happy to announce the following tutorials, now available online. Available now are written and video tutorials covering all DynamicPDF Cloud API's REST endpoints.

pdfMerging PDFs
Completing an AcroForm
Creating a PDF from DLEX
Adding Bookmarks to a PDF
dlex-layoutCreate a PDF from DLEX
image-infoExtract Image Metadata
pdf-infoExtract PDF Metadata
pdf-textExtract PDF's Text
pdf-xmpExtract XMP Metadata

Each tutorial includes examples using the following client libraries.

  • Java
  • C# .NET
  • Node.js
  • PHP

Be sure to check out the tutorials for step-by-step instructions on calling each endpoint using one of the client libraries or using a direct REST call using cURL.

· One min read
James A. Brannan

Recently we started creating numerous written tutorials and video tutorials to help you get started using the DynamicPDF Cloud API. We are happy to announce our first tutorial: Getting Started - DLEX and Designer.

This short tutorial illustrates how to create a simple dynamic PDF report. We first use DynamicPDF Cloud API's Designer to create a DLEX report template and associated JSON data. After creating the DLEX file, we illustrate using DynamicPDF Cloud API's dlex-layout REST endpoint to process the DLEX file and generate a PDF document.

The tutorial is designed as your "first steps" using DynamicPDF Cloud API, so be sure to check it out.

Getting Started - DLEX and Designer

· One min read
Andrew Cochran

One of the critical features of the DynamicPDF Cloud API is its ability to scale based on demand automatically. Our team has been working hard to test out this feature over the past few weeks. We've been testing like crazy and have created over 1.2 billion test pages in the process. We're happy to report that auto-scaling is now up and running in all 10 of our geographic zones and performing quite nicely. We'll keep testing and tweaking things as usage increases to ensure things continue to run optimally.