Layout

Preconfigured Page Sizes

By default, a PDF's page size is set to A4. Using the API's page_size parameter a custom page size can be specified. Please find in the table below all page sizes supported by the PDFlayer API.

Example API Request:

Supported Page Sizes:

Dimensions

Instead of specifying a preconfigured Page Size the PDFlayer API also accepts two page dimension parameters. page_width and page_height.

Please be aware that specifying these dimension parameters will override any specified preconfigured Page Sizes.

Example API Request:

Parameter Specification:

Orientation

By default, a PDF's orientation is set to portrait. Using the API's orientation parameter the PDF document's orientation can be set to either portrait or landscape.

Example API Request:

Parameter Specification:

Margins

A PDF's default margin is set to 10 millimeters on each side. Using the parameters margin_top, margin_bottom, margin_left and margin_right vertical and horizontal margins (in the selected Document Unit) can be specified.

Example API Request:

Parameter Specification:

Header

There are two different types of custom header elements that can be included in a PDF document: A header text or a custom header HTTP URL or raw HTML element.

Header Text

A simple header text can be specified by appending the PDFlayer API's header_text parameter to your API request URL and setting it to your preferred header text. By default, this header text is aligned at the center of the document. The API's header_align parameter enables you to specify a custom header alignment, choosing from left, right or center.

Example API Request:

Parameter Specification:

Header URL or Raw HTML Element

As an alternative to specifying a header text, the PDFlayer API is also capable of including the HTML contents of an external HTTP URL or raw HTML code as a header element in your final PDF document.

Example API Request using a HTTP header URL:

Parameter Specification:

Header Spacing

By default, there is no extra space between a header element and the PDF document content. A header spacing can be specified by appending your preferred numeric value to the API's header_spacing parameter.

Example API Request using a HTTP header URL:

https://api.pdflayer.com/api/convert
    ? access_key = YOUR_ACCESS_KEY
    & document_url = http://example.com/document.html
    & footer_text = myFooterText
    & footer_align = left
    [...]

Footer URL or Raw HTML Element

NOTE: Kindly ensure that the footer URL is formatted using the appropriate HTML tags. Please refer to the HTML snippet below for reference.

Footer Spacing

By default, there is no extra space between a footer element and the PDF document content. A footer spacing can be specified by appending your preferred numeric value to the API's footer_spacing parameter.

Viewport Control

The PDFlayer API's default viewport setting is 1440x900. You can specify a custom viewport size by setting the viewport parameter to your desired dimensions. (format: width x height, in pixels)

Important: When requesting mobile-sized viewports, it is highly recommended to also specify a user_agent parameter, as certain websites tend to ignore mobile viewports that come without specified HTTP User-Agent headers (See User-Agent parameter).

Example API request using permission options:

Parameter Specification