Blog Post

How to Watermark a PDF Using PHP

Jonathan D. Rhyne
Illustration: How to Watermark a PDF Using PHP

In this post, you’ll learn how to watermark a PDF using our Watermark PDF PHP API. With our API, you receive 100 credits with the free plan. Different operations on a document consume different amounts of credits, so the number of PDF documents you can generate may vary. You’ll just need to create a free account to access your API key.

This post will be especially helpful for developers working with PHP in document-heavy workflows who need to programmatically watermark PDFs.

Watermarks are used to identify and mark proprietary documents and discourage unauthorized use. In the context of a PDF, a watermark is usually found in the form of text or an image that appears on a document like a stamp. The most common example is applying a CONFIDENTIAL watermark to sensitive documents.

PSPDFKit API

Watermarking PDFs is just one of the operations possible with our 30+ PDF API tools. You can combine our deletion tool with other tools to create complex document processing workflows, such as:

  • Converting MS Office files and images into PDFs and then watermarking them

  • Duplicating or deleting PDF pages before watermarking a PDF

  • Merging or flattening PDFs and then watermarking the resulting document

Once you create your account, you’ll be able to access all our PDF API tools.

Step 1 — Creating a Free Account on PSPDFKit

Go to our website, where you’ll see the page below, prompting you to create your free account.

Free account PSPDFKit API

Once you’ve created your account, you’ll be welcomed by the page below, which shows an overview of your plan details.

Free plan PSPDFKit API

As you can see in the bottom-left corner, you’ll start with 100 credits to process, and you’ll be able to access all our PDF API tools.

Step 2 — Obtaining the API Key

After you’ve verified your email, you can get your API key from the dashboard. In the menu on the left, click API Keys. You’ll see the following page, which is an overview of your keys:

Watermark PDF PHP API Key

Copy the Live API Key, because you’ll need this for the Watermark PDF API.

Step 3 — Setting Up Folders and Files

Now, create a folder called watermark_pdf and open it in a code editor. For this tutorial, you’ll use VS Code as your primary code editor. Next, create two folders inside watermark_pdf and name them input_documents and processed_documents.

Copy your PDF file to the input_documents folder and rename it to document.pdf. Then, place an image that you want to use to watermark the PDF pages in this folder and name it logo.png.

Finally, in the root folder, watermark_pdf, create a file called processor.php. This is the file where you’ll keep your code.

Your folder structure will look like this:

watermark_pdf
├── input_documents
|    └── document.pdf
|    └── logo.png
├── processed_documents
└── processor.php

Step 4 — Writing the Code

Open the processor.php file and paste the code below into it:

<?php

$FileHandle = fopen('processed_documents/result.pdf', 'w+');

$curl = curl_init();

$instructions = '{
  "parts": [
    {
      "file": "document"
    }
  ],
  "actions": [
    {
      "type": "watermark",
      "image": "logo",
      "width": "25%"
    }
  ]
}';

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.pspdfkit.com/build',
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_POSTFIELDS => array(
    'instructions' => $instructions,
    'document' => new CURLFILE('input_documents/document.pdf'),
    'logo' => new CURLFILE('input_documents/logo.png')
  ),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_API_KEY_HERE' // Replace YOUR_API_KEY_HERE with your API key.
  ),
  CURLOPT_FILE => $FileHandle,
));

$response = curl_exec($curl);

curl_close($curl);

fclose($FileHandle);

ℹ️ Note: Make sure to replace YOUR_API_KEY_HERE with your API key.

Code Explanation

In the code above, you create a FileHandle variable that will allow you to save the file in the processed_documents folder.

Then, you create the instructions variable, where all the instructions for the API will be stored in the form of a JSON string. Finally, you make a CURL request.

Output

To execute the code, use the command below:

php processor.php

On successful execution, you’ll see a new processed file, result.pdf, located in the processed_documents folder.

The folder structure will look like this:

watermark_pdf
├── input_documents
|    └── document.pdf
|    └── logo.png
├── processed_documents
|    └── result.pdf
└── processor.php

Final Words

In this post, you learned how to easily and automatically watermark PDF documents for your PHP application using our Watermark PDF API.

You can integrate these functions into your existing applications to watermark PDF pages. With the same API token, you can also perform other operations, such as merging documents into a single PDF, running OCR, duplicating pages, and more. To get started with a free trial, sign up here.

Author
Jonathan D. Rhyne Co-Founder and CEO

Jonathan joined Nutrient in 2014. As CEO, Jonathan defines the company’s vision and strategic goals, bolsters the team culture, and steers product direction. When he’s not working, he enjoys being a dad, photography, and soccer.

Explore related topics

Related products

PSPDFKit API

Product page Guides

Share post
Free trial Ready to get started?
Free trial