How to Flatten Layers of a PDF with Python

Why Flatten Layers with Python?

The pdfRest Flatten Layers API Tool is a powerful resource for developers who need to programmatically flatten layers in PDF documents. Flattening layers merges all visible layers into a single layer, which can be useful for ensuring consistent viewing across different platforms and software.

For example, a graphic designer might need to flatten a PDF before sending it to a print shop to prevent any layers from being accidentally altered or omitted during the printing process. This tutorial will guide you through the process of sending an API call to Flatten Layers using Python.

Flatten Layers with Python Code Example

from requests_toolbelt import MultipartEncoder
import requests
import json

flattened_layers_pdf_endpoint_url = 'https://api.pdfrest.com/flattened-layers-pdf'

mp_encoder_flattenedPDF = MultipartEncoder(
    fields={
        'file': ('file_name.pdf', open('/path/to/file', 'rb'), 'application/pdf'),
        'output' : 'example_out'
    }
)

headers = {
    'Accept': 'application/json',
    'Content-Type': mp_encoder_flattenedPDF.content_type,
    'Api-Key': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # place your api key here
}

print("Sending POST request to flattened-layers-pdf endpoint...")
response = requests.post(flattened_layers_pdf_endpoint_url, data=mp_encoder_flattenedPDF, headers=headers)

print("Response status code: " + str(response.status_code))

if response.ok:
    response_json = response.json()
    print(json.dumps(response_json, indent = 2))
else:
    print(response.text)

Source of the provided code: GitHub

Breaking Down the Python Code

The provided Python code performs the following steps to flatten layers in a PDF document:

flattened_layers_pdf_endpoint_url = 'https://api.pdfrest.com/flattened-layers-pdf'

This line sets the endpoint URL for the Flatten Layers API tool.

mp_encoder_flattenedPDF = MultipartEncoder(
    fields={
        'file': ('file_name.pdf', open('/path/to/file', 'rb'), 'application/pdf'),
        'output' : 'example_out'
    }
)

The MultipartEncoder is used to build the multipart/form-data payload. It includes the PDF file to be flattened and the desired output name.

headers = {
    'Accept': 'application/json',
    'Content-Type': mp_encoder_flattenedPDF.content_type,
    'Api-Key': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # place your api key here
}

Headers are set to accept JSON responses, declare the content type, and include the API key for authentication.

response = requests.post(flattened_layers_pdf_endpoint_url, data=mp_encoder_flattenedPDF, headers=headers)

This line sends the POST request with the payload and headers to the endpoint.

if response.ok:
    response_json = response.json()
    print(json.dumps(response_json, indent = 2))
else:
    print(response.text)

If the request is successful, the response is printed in a readable JSON format. Otherwise, the error text is printed.

Beyond the Tutorial

By following the steps outlined above, you have learned how to make an API call to the pdfRest Flatten Layers API using Python. You can now use this knowledge to automate the process of flattening layers in PDFs for various applications. To further explore the capabilities of pdfRest, you can demo all of the pdfRest API Tools in the API Lab at https://pdfrest.com/apilab/. Additionally, refer to the API Reference documentation at https://pdfrest.com/documentation/ for more details on how to use the different features offered by the service.

Note: This is an example of a multipart API call. Code samples using JSON payloads can be found at GitHub.