This add-on is operated by Expedited Security

Generate PDF Documents from Webpages.

Last updated July 28, 2023

Web to PDF is an add-on to generate PDF Documents from Webpages.

Quickly generate PDF documents from any web page. Tweak styling and rendering options to make your PDFs look as professional as possible.

Web to PDF exposes an API and has supported examples for Ruby, PHP, Python, Node and Java.

Provisioning the add-on

Web to PDF can be attached to a Heroku application via the CLI:

$ heroku addons:create webtopdf
-----> Adding webtopdf to sharp-mountain-4005... done, v18 (free)

Once Web to PDF has been added a WEBTOPDF_API_KEY config variable will contain your specific API key granting access to the newly provisioned Web to PDF instance. This can be confirmed using the heroku config:get command.

$ heroku config:get WEBTOPDF_API_KEY
Bl4XHVbdsf5GIXQbqTfXR5IrpuuXER2kaVc2zNnA

After installing Web to PDF your application should be modified to fully integrate with the add-on.

Local setup

Environment setup

After provisioning the add-on it’s necessary to locally replicate the config vars so your development environment can operate against the service.

Use the Heroku Local command-line tool to configure, run and manage process types specified in your app’s Procfile. Heroku Local reads configuration variables from a .env file. To view all of your app’s config vars, type heroku config. Use the following command for each value that you want to add to your .env file.

$ heroku config:get WEBTOPDF_API_KEY -s  >> .env

For more information, see the Heroku Local article.

Input Parameter Descriptions

All languages will follow this call structure for inputs.

Using with Ruby

Install the Web-To-Pdf gem.

# In your Gemfile
gem 'webtopdf', git: 'https://github.com/mbuckbee/Web-To-Pdf-Gem.git'

Making a Request

> require 'web_to_pdf'
=> true

# Note: the 'Controller' here is not a reference to Rails controllers
# but an internal structure, won't interfere with your Rails app and will
# work fine in a standalone ruby app or another framework

> wtp = WebToPdf::APIController.new
> data = wtp.lookup("https://news.ycombinator.com/", "10", "1024", "Wikipedia")

# Writes the PDF file to the local directory
> File.open("news-yc.pdf","w"){|f| f.write(data)}

Using with PHP

<?php

$ch = curl_init('https://webtopdf.expeditedaddons.com/?api_key=' . getenv('WEBTOPDF_API_KEY') . '&content=http%3A%2F%2Fwww.wikipedia.org&html_width=1024&margin=10&title=My+PDF+Title');

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

Using with Python

import os
from urllib2 import Request, urlopen

request = Request('https://webtopdf.expeditedaddons.com/?api_key=' + os.environ['WEBTOPDF_API_KEY'] + '&content=http%3A%2F%2Fwww.wikipedia.org&html_width=1024&margin=10&title=My+PDF+Title')

response_body = urlopen(request).read()
print response_body

Using with Node

var request = require('request');

request('https://webtopdf.expeditedaddons.com/?api_key=' + process.env.WEBTOPDF_API_KEY + '&content=http%3A%2F%2Fwww.wikipedia.org&html_width=1024&margin=10&title=My+PDF+Title', function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});

Using with Java

// Maven : Add these dependencies to your pom.xml (java6+)
// <dependency>
//     <groupId>org.glassfish.jersey.core</groupId>
//     <artifactId>jersey-client</artifactId>
//     <version>2.8</version>
// </dependency>
// <dependency>
//     <groupId>org.glassfish.jersey.media</groupId>
//     <artifactId>jersey-media-json-jackson</artifactId>
//     <version>2.8</version>
// </dependency>

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;

Client client = ClientBuilder.newClient();
Response response = client.target('https://webtopdf.expeditedaddons.com/?api_key=' + System.getenv('WEBTOPDF_API_KEY') + '&content=http%3A%2F%2Fwww.wikipedia.org&html_width=1024&margin=10&title=My+PDF+Title}')
  .request(MediaType.TEXT_PLAIN_TYPE)
  .get();

System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));

Dashboard

The Web to PDF dashboard allows you to monitor your API usage limits.

The dashboard can be accessed via the CLI:

$ heroku addons:open webtopdf
Opening webtopdf for sharp-mountain-4005

or by visiting the Heroku Dashboard and selecting the application in question. Select Web to PDF from the Add-ons menu.

Troubleshooting

As a sanity check it is sometimes useful to bypass your app stack and check the endpoint, your API Key and parameters directly.

Test with your browser

# Modify the following to use your actual API Key
https://webtopdf.expeditedaddons.com/?api_key=REPLACE_WITH_YOUR_WEBTOPDF_API_KEY&content=http%3A%2F%2Fwww.wikipedia.org&html_width=1024&margin=10&title=My+PDF+Title

A successful call will return your requested data with a HTTP result code of 200 along with your data. We recommend the JSON Formatter extension as a useful tool.

Your API key can be found on your Web to PDF dashboard.

Migrating between plans

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade webtopdf:newplan
-----> Upgrading webtopdf:newplan to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: webtopdf:newplan

Removing the add-on

Web to PDF can be removed via the CLI.

$ heroku addons:destroy webtopdf
-----> Removing webtopdf from sharp-mountain-4005... done, v20 (free)

Support

All Web to PDF support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at support@expeditedaddons.com