html2pdf.app

https://html2pdf.app/documentation
Admin
html2pdf.app is an API service that converts HTML content or website URLs into PDF documents,...
Tokens:4,620
Snippets:23
Trust Score:7.3
Update:9 months ago
Show doc for...
Tokens:
Raw
### Header/Footer Template Example (HTML)

Source: https://html2pdf.app/documentation/index

An HTML template example for generating headers and footers in PDF documents. It utilizes specific class names (date, title, url, pageNumber, totalPages) to dynamically insert relevant information.

```html
<div style="font-size: 12px; padding: 0 12px; width: 100%; text-align: center;">
    Page: <span class="pageNumber"></span> of <span class="totalPages"></span> | 
    Date: <span class="date"></span> | 
    Title: <span class="title"></span> | 
    URL: <span class="url"></span> | 
    Total: <span class="totalPages"></span>
</div>
```

--------------------------------

### API Authentication Example (cURL)

Source: https://html2pdf.app/documentation/index

Demonstrates how to authenticate API requests using an API key via a cURL POST request. The apiKey is a private credential obtained after registration and should not be exposed publicly.

```curl
curl -X POST https://api.html2pdf.app/v1/generate \
-H 'Content-Type: application/json' \
-d '{
  "html": "https://www.example.com",
  "apiKey": "your-api-key"
}'
```

--------------------------------

### Page Break Example

Source: https://html2pdf.app/documentation/index

Demonstrates how to implement page breaks within your HTML content using CSS for multi-page PDF generation.

```APIDOC
## Page Breaks

### Description
To force a page break at a specific point in your HTML document, you can use CSS with a class that applies `page-break-after: always;`.

### Method
N/A (demonstrates HTML structure)

### Endpoint
N/A

### Request Body Example (HTML Structure)
```html
<html>
    <head>
        <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
        <title>Paginated HTML</title>
        <style>
             div.page {
                page-break-after: always;
                page-break-inside: avoid;
            }
        </style>
    <head>
    <body>
        <div class="page">
            <h1>This is Page 1</h1>
        </div>
        <div class="page">
            <h1>This is Page 2</h1>
        </div>
        <div class="page">
            <h1>This is Page 3</h1>
        </div>
    </body>
</html>
```
```

--------------------------------

### PDF Encryption Parameters and cURL Example

Source: https://html2pdf.app/documentation/index

Explains the parameters for encrypting PDF documents using AES 128-bit encryption, including `userPassword`, `ownerPassword`, and `permissions`. The `userPassword` is required to initiate encryption, while `ownerPassword` grants full access. The `permissions` array controls user actions. An example cURL request demonstrates how to apply these settings.

```bash
curl --output example.pdf --request POST \
  --url https://api.html2pdf.app/v1/generate \
  --header 'Content-Type: application/json' \
  --data '{ 
    "apiKey": "f117a90d3a0864645264f700b79161d5da8cb...",
    "html": "https://example.com",
    "userPassword": "user",
    "ownerPassword": "owner",
    "permissions": ["print", "modify", "copy"]
}'
```

--------------------------------

### HTML Template with Custom CSS and Image for Footer

Source: https://html2pdf.app/documentation/index

Provides an example of an HTML template designed for use with PDF generation, including custom CSS for styling and a base64 encoded image within the footer. Note that web CSS is not supported in the header/footer, so styles must be inlined or within the template. The `-webkit-print-color-adjust: exact;` property is crucial for rendering background colors.

```html
<html>
<head>
<style>
  html {
    -webkit-print-color-adjust: exact; /* this is important to show background color */
  }
  body {
    font-size: 20px;
    font-family: 'Arial Narrow', serif;
  }
  .footer {
    padding: 0 12px;
    width: 100%;
    text-align: center;
  }
</style>
</head>
<body>
<div class="footer">Page: <span class="pageNumber"></span> of <span
        class="totalPages"></span> | Date: <span class="date"></span> | Title: <span class="title"></span> <img
        src="data:image/png;base64, iVBORw0KGgoAAAA...kJggg=="
        style="width:30px;height:30px;" /> | URL: <span class="url"></span> | Total: <span class="totalPages"></span>
</div>
</body>
</html>
```

--------------------------------

### HTML Structure for Page Breaks

Source: https://html2pdf.app/documentation/index

Provides an HTML structure example to enforce page breaks within a document. The CSS class 'page' with 'page-break-after: always;' is used to ensure content is divided into distinct pages.

```html
<html>
    <head>   
        <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
        <title>Paginated HTML</title>
        <style>
             div.page {
                page-break-after: always; 
                page-break-inside: avoid;
            }   
        </style> 
    <head>
    <body> 
        <div class="page">
            <h1>This is Page 1</h1>
        </div>
        <div class="page">
            <h1>This is Page 2</h1>
        </div>
        <div class="page">
            <h1>This is Page 3</h1>
        </div>
    </body>
</html>
```

--------------------------------

### Generate PDF with Basic Options via cURL

Source: https://html2pdf.app/documentation/index

This cURL command demonstrates a basic integration for generating a PDF from a given URL. It shows how to set the output file, request method, content type, and provides a JSON payload including the HTML source, API key, and options like `landscape` and `format`.

```bash
curl -X POST https://api.html2pdf.app/v1/generate \
-H 'Content-Type: application/json' \
-d '{
  "html": "https://www.example.com",
  "apiKey": "your-api-key",
  "landscape": true,
  "format": "A4"
}'
```

--------------------------------

### Header and Footer Template

Source: https://html2pdf.app/documentation/index

Explains how to use the `headerTemplate` and `footerTemplate` parameters to add custom headers and footers to your PDF documents.

```APIDOC
## Header and Footer

### Description
Custom HTML content can be provided for headers and footers using the `headerTemplate` and `footerTemplate` parameters. Specific classes can be used within the HTML to dynamically insert values like page numbers, dates, and titles.

### Method
N/A (demonstrates parameter usage)

### Endpoint
N/A

### Parameters
- **headerTemplate** (string) - Optional - HTML markup for the header. Requires sufficient `marginTop`.
- **footerTemplate** (string) - Optional - HTML markup for the footer. Requires sufficient `marginBottom`.

### Available Classes for Templates:
- **date**: Formatted print date.
- **title**: Document title.
- **url**: Document location.
- **pageNumber**: Current page number.
- **totalPages**: Total number of pages.

### Template Code Example
```html
<div style="font-size: 12px; padding: 0 12px; width: 100%; text-align: center;">
    Page: <span class="pageNumber"></span> of <span class="totalPages"></span> | 
    Date: <span class="date"></span> | 
    Title: <span class="title"></span> | 
    URL: <span class="url"></span> | 
    Total: <span class="totalPages"></span>
</div>
```
```

--------------------------------

### HTML to PDF Generation

Source: https://html2pdf.app/documentation/index

This endpoint generates a PDF document from provided HTML content. It supports various configurations for styling, headers, footers, and encryption.

```APIDOC
## POST /v1/generate

### Description
Generates a PDF document from HTML content. Supports custom headers, footers, fonts, images, and encryption.

### Method
POST

### Endpoint
`/v1/generate`

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key for authentication.
- **html** (string) - Required - The HTML content or URL to convert.
- **landscape** (boolean) - Optional - Set to true for landscape orientation.
- **format** (string) - Optional - The page format (e.g., A4, Letter).

#### Request Body
- **userPassword** (string) - Optional - Password for opening the PDF.
- **ownerPassword** (string) - Optional - Owner password to grant full access and allow modification of permissions.
- **permissions** (array) - Optional - Controls user permissions when `userPassword` is set. Accepted values: `print`, `modify`, `copy`, `edit`, `fillform`, `extract`, `assemble`, `printbest`. Default is `["print"]`.

### Request Example
```json
{
  "html": "https://www.example.com",
  "apiKey": "your-api-key",
  "landscape": true,
  "format": "A4",
  "userPassword": "user",
  "ownerPassword": "owner",
  "permissions": ["print", "modify", "copy"]
}
```

### Response
#### Success Response (200)
- **pdf** (string) - The generated PDF file content or a URL to the PDF.

#### Response Example
(Binary data for the PDF file or a URL)

## Encryption Details

When encrypting a PDF document, you can provide a `userPassword` and an `ownerPassword`. The user password restricts operations like viewing, printing, copying, and modifying the PDF. The owner password grants full access and the ability to change permissions.

We support AES encryption with 128 bits key.

### Permissions
- `print`: Allow printing.
- `modify`: Allow template creation, signing, filling form fields.
- `copy`: Allow content copying and copying for accessibility.
- `edit`: Allow commenting.
- `fillform`: Allow filling of form fields.
- `extract`: Allow content copying for accessibility.
- `assemble`: Allow assembling the document (rotate, insert, delete pages, bookmarks, thumbnails).
- `printbest`: Allow high-resolution printing when 'print' is allowed.

### Custom Headers and Footers

To add images to the header or footer, use base64 encoded content in the `src` attribute of an `<img>` tag.

```html
<img src="data:image/png;base64, iVBORw0KGgo...AAAANSUh==" style="width:30px; height:30px;" />
```

CSS from the web page is not supported in headers or footers. All styles must be provided separately in the template's code. Supported fonts can be used.

### Template Example with Custom CSS and Image

```html
<html>
<head>
<style>
  html {
    -webkit-print-color-adjust: exact; /* this is important to show background color */
  }
  body {
    font-size: 20px;
    font-family: 'Arial Narrow', serif;
  }
  .footer {
    padding: 0 12px;
    width: 100%;
    text-align: center;
  }
</style>
</head>
<body>
<div class="footer">
  Page: <span class="pageNumber"></span> of <span class="totalPages"></span> | Date: <span class="date"></span> | Title: <span class="title"></span> <img src="data:image/png;base64, iVBORw0KGgoAAAA...kJggg==" style="width:30px;height:30px;" /> | URL: <span class="url"></span> | Total: <span class="totalPages"></span>
</div>
</body>
</html>
```
```

--------------------------------

### HTML to PDF Generation

Source: https://html2pdf.app/documentation/index

This endpoint allows you to convert HTML content or a URL into a PDF document. You can authenticate using an API key and customize various aspects of the PDF.

```APIDOC
## POST /v1/generate

### Description
Converts HTML content or a website URL into a PDF document. Authentication is required using an API key.

### Method
POST

### Endpoint
`/v1/generate`

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key obtained after registration.

#### Request Body
- **html** (string) - Required - HTML code or a URL of the website to convert.
- **apiKey** (string) - Required - Your API key.
- **callBackUrl** (string) - Optional - A URL to receive the generated PDF document (base64 encoded) upon completion.
- **state** (string) - Optional - A custom parameter to be sent to the `callBackUrl`.
- **landscape** (boolean) - Optional - Set to `true` for landscape mode. Defaults to `false`.
- **format** (string) - Optional - The format of the document. Options: `Letter`, `Legal`, `Tabloid`, `Ledger`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`. Defaults to `A4`.
- **width** (integer) - Optional - Custom width of the PDF size (use with `height`).
- **height** (integer) - Optional - Custom height of the PDF size (use with `width`).
- **marginTop** (integer) - Optional - Top margin in pixels. Defaults to `0`.
- **marginRight** (integer) - Optional - Right margin in pixels. Defaults to `0`.
- **marginBottom** (integer) - Optional - Bottom margin in pixels. Defaults to `0`.
- **marginLeft** (integer) - Optional - Left margin in pixels. Defaults to `0`.
- **filename** (string) - Optional - Sets the filename header for the response.
- **waitFor** (integer) - Optional - Time in seconds (0-10) to wait before generating the PDF, useful for JavaScript execution. Defaults to `0`.
- **media** (string) - Optional - Use `print` for print styles, `screen` for screen styles. Defaults to `screen`.
- **scale** (number) - Optional - Scale of the PDF content. Range: `0.1` to `2`. Defaults to `1`.
- **headerTemplate** (string) - Optional - HTML code for the header. Use with `marginTop`.
- **footerTemplate** (string) - Optional - HTML code for the footer. Use with `marginBottom`.

### Request Example
```json
{
  "html": "https://www.example.com",
  "apiKey": "your-api-key"
}
```

### Response
#### Success Response (200)
- **document** (string) - Base64 encoded PDF document (if `callBackUrl` is not provided).

#### Response Example
```json
{
  "document": "JVBERi0xLjQKJcfsj6IKMiAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDEgMC9SJiZib2R5PDwvVHlwZS9FcnJvci9Db2RlNTQvTWVzc2FnZSgnWW91ciBBUEkga2V5IGlzIGludmFsaWQhJz4+Pj4="
}
```
```

--------------------------------

### Embedding Base64 Encoded Image in HTML

Source: https://html2pdf.app/documentation/index

Demonstrates how to embed an image directly into an HTML element's src attribute using base64 encoding. This method is useful for including images in headers or footers where external resources cannot be loaded. The image format and dimensions can be specified within the tag.

```html
<img src="data:image/png;base64, iVBORw0KGgo...AAAANSUh==" style="width:30px; height:30px;" />
```
Tokens:
Raw