API Version 5

We have released a major new release on the HTML To PDF API. It is mostly backwards compatible.

New Features

  • privacy parameter: If you set privacy=true on your calls. This ensured that we will not store the resulting document or any immediate render for caching or future use. The captured document will be streamed directly to you and will be discarded.

    • Note that this parameter is not compatible with json=true as that requires us to save and host the resulting document.
  • cache_ttl parameter: The new API has caching disabled by default. We have removed the fresh parameter from the earlier versions. Not every call returns a fresh capture. If you wish to cache documents for repeated calls, please set cache_ttl to maximum number of seconds you wish to cache your resulting documents.

Improvements

The new API is faster and more reliable due to architectural changes. In order to minimize the call latency, we made several changes to our pipeline and you should see the results on your API calls.

Upgrade

In order to switch to the new version, you can simply change your API call url to https://restpack.io/api/html2pdf/v5/convert. If you do not need caching, there would be no more changes required.

Custom Headers and Footers on Startup Plan

Due to popular demand, we decided to enable custom PDF headers and footers on our Startup plan. If you already on the Startup plan, you can immediatly start using these features.

Custom Filenames

We just added custom filenames support to the API. In order to save your files with a specified filename, you can now pass a filename=xx.pdf parameter. If you also set json=true, that will return a CDN path ending with your requested filename. Otherwise, we will add a content-disposition header to ensure that client browsers do download the file with the filename that you provide.

GDPR Compliance

We have updated our privacy policy to meet the new EU data protection regulation requirements. We have also created a legal agreement promising the protection of all personally identifiable information and sensitive information that we collect and store.

Privacy Policy

Data Processing Agreement

API Version 4

We have released the new major version of our HTML to PDF API, here are the highlights:

  • Page Headers and Footers
  • Custom Page Sizes
  • Ad / EU Cookie Warning Blocking

New Features

Page Headers and Footers
One of the most requested features. We now support automatically injecting header and footer templates to generated PDF documents. You can create these segments in full HTML and customize as you wish. It is also possible to insert dynamic data such as page number, document title etc into the headers and footers.

Custom Page Sizes
In addition to pdf_page parameter, now it’s possible to send pdf_width and pdf_height parameters to set up a custom page size.

Ad / Cookie Warning Blocking
We have two new options, block_ads and block_cookie_warnings in order to apply blocking rules to the page before conversion.

Changes

  • We used to generate PDFs on print CSS media. However, the API now defaults to screen media in order to generate documents as close as to how they look on a browser. You can switch to print using emulate_media: print setting

Upgrade

V4 is completely backwards compatible and can be used by just changing the API call url to https://restpack.io/api/html2pdf/v4/convert

Fixed Shutters Not Firing

We have a shutter feature that can be used to wait for an element to be visible. However it was not working as expected in rare situations, causing the entire capture job to fail.

This functionality has been fixed and you can reliably use shutter options in your API calls.

Delay Option Improvements

We have made several improvements to delay option and the order which we apply the delay.

Delay is now applied after all javascript / css injection jobs are completed and several jobs causing implicit delays (such as prescrolling page to render lazy assets) are merged together so their delays will not stack together.

Wait mode: dom

It is now possible to pass wait=dom parameter in order to wait for domready event before render. The default is wait=load which waits for window.onload event.

This way you can create faster captures and handle such sites where loading hangs or takes a lot of time.

Faster API Calls

We have deployed a new capturing architecture which improves our capturing performance 30% in average. These changes have been made available to all users without any modifications required on your side.

Stability Fixes

Based on our monitoring, we identified several browser crashes occuring during captures. These have been mostly visible in the latest weeks. All issues should be resolved as of now.

Show Previous Entries