How to create a PDF with a Image-Based Watermark

Using DocRaptor's API

Below are the basics of using DocRaptor's HTTP API. It can easily be used in any programming language, but if we don't have a native agent for your language, please let us know! That'll help us write the best examples and agents.

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

To make documents, send a POST request to this URL:

https://YOUR_API_KEY_HERE@staging-api.docraptor.com/docs

Send JSON-encoded API parameters (you'll need to set an HTTP header for Content-Type as application/json). These are the only required parameters:

{
  "type": "pdf",
  "document_content": "Hello World!"
}

Generating the Document with cURL

Here's a completely functional code sample for this tutorial:

cat <<-'DOCUMENT_OPTIONS' > docraptor_parameters.json
  {
    "test": false,
    "document_type": "pdf",
    "document_content": "<div id=\"watermark\"><img src=\"https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png\" /></div><div style=\"page-break-after: always;\">Page 1</div><div style=\"page-break-after: always;\">Page 2</div><div style=\"page-break-after: always;\">Page 3</div><style>#watermark {flow: static(watermarkflow);opacity: 0.7;text-align: center;}@page {@prince-overlay {content: flow(watermarkflow);}}</style>"
  }
DOCUMENT_OPTIONS

curl https://YOUR_API_KEY_HERE@api.docraptor.com/docs \
  --fail --silent --show-error \
  --header "Content-Type:application/json" \
  --data @docraptor_parameters.json \
  > image-based-watermark.pdf

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.2.3 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

Installing the .NET Agent

With Nuget:

nuget.exe install DocRaptor

With the Package Manager Console:

Install-Package DocRaptor

You can also download the DLL directly from GitHub.

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

using DocRaptor.Client;
using DocRaptor.Model;
using DocRaptor.Api;
using System;
using System.IO;

class DocRaptorExample
{
    static void Main(string[] args)
    {
        DocApi docraptor = new DocApi();
        // this key works in test mode!
        docraptor.Configuration.Username = "YOUR_API_KEY_HERE";

        try
        {
            Doc doc = new Doc(
                name: "image-based-watermark",
                test: false, // test documents are free but watermarked
                documentType: Doc.DocumentTypeEnum.Pdf,
                documentContent: System.IO.File.ReadAllText(@"image-based-watermark-content.html") 
                // documentUrl: "https://docraptor.com/examples/invoice.html", 
                // javascript: true, 
                // princeOptions: new PrinceOptions(
                //     media: "print", // @media 'screen' or 'print' CSS
                //     baseurl: "https://yoursite.com" // the base URL for any relative URLs
                // )
            );

            byte[] document = docraptor.CreateDoc(doc);
            File.WriteAllBytes("image-based-watermark.pdf", document);
            Console.WriteLine("Successfully created image-based-watermark.pdf!");
        } catch (DocRaptor.Client.ApiException error) {
            Console.Write(error.ErrorContent);
        }
    }
}

Install the Java Agent

Add the com.docraptor package to your project. For example, with Maven you'd add the DocRaptor package to your pom.xml:

<dependency>
  <groupId>com.docraptor</groupId>
  <artifactId>docraptor</artifactId>
  <version>3.0.0</version>
</dependency>

And then install it:

mvn install com.docraptor

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

import com.docraptor.*;
import java.io.*;
import java.net.*;
import java.nio.file.*;

public class DocRaptorExample {

  public static void main(String[] args) throws Exception {
    DocApi docraptor = new DocApi();
    ApiClient client = docraptor.getApiClient();
    client.setUsername("YOUR_API_KEY_HERE"); // this key works in test mode!

    try {
      Doc doc = new Doc();
      doc.setTest(false); // test documents are free but watermarked
      doc.setDocumentType(Doc.DocumentTypeEnum.PDF);

      doc.setDocumentContent(new String(Files.readAllBytes(Paths.get("image-based-watermark-content.html"))));

      // doc.setDocumentUrl("https://docraptor.com/examples/invoice.html");
      // doc.setJavascript(true);
      // PrinceOptions princeOptions = new PrinceOptions();
      // princeOptions.setMedia("print"); // @media 'screen' or 'print' CSS
      // princeOptions.setBaseurl("https://yoursite.com"); // the base URL for any relative URLs
      // doc.setPrinceOptions(princeOptions);

      byte[] document = docraptor.createDoc(doc);

      // createDoc() returns a binary string
      FileOutputStream file = new FileOutputStream(
        "image-based-watermark.pdf"
      );
      file.write(document);
      file.close();
      System.out.println("Successfully created image-based-watermark.pdf!");
    } catch (ApiException error) {
      System.err.println(error);
      System.err.println(error.getCode());
      System.err.println(error.getMessage());
      System.err.println(error.getResponseBody());
    }
  }
}

The DocRaptor JavaScript Library

The DocRaptor JavaScript library makes it easy to create PDFs with JavaScript. The library does not require jQuery, but you can use jQuery to define your document content. When a PDF is requested, the library constructs a hidden form and submits it to the DocRaptor API. The form is necessary to trigger the browser download window.

This library exposes your API key in your website source code. This code should never be used in a publicly-accessible location, instead try using our referrer-based API or a server-side agent such as PHP or Ruby.

JavaScript Example

<html>
  <head>
    <script src="https://docraptor.com/docraptor-1.0.0.js"></script>
    <script>
      var downloadDocumentFrom = function(selector) {
        // this key works in test mode!
        DocRaptor.createAndDownloadDoc("YOUR_API_KEY_HERE", {
          name: "image-based-watermark",
          test: false, // test documents are free but watermarked
          document_type: "pdf",
          document_content: document.querySelector(selector).innerHTML
          // document_url: "https://docraptor.com/examples/invoice.html",
          // javascript: true,
          // prince_options: {
          //   media: "print", // @media 'screen' or 'print' CSS
          //   baseurl: "https://yoursite.com", // the base URL for any relative URLs
          // }
        });
      };
    </script>
    <style>
      @media print {
        #download-button {
          display: none;
        }
      }
    </style>
  </head>
  <body>
    <div id="watermark"><img src="https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png" /></div>
    <div style="page-break-after: always;">Page 1</div>
    <div style="page-break-after: always;">Page 2</div>
    <div style="page-break-after: always;">Page 3</div>

    <style>
      #watermark {
        flow: static(watermarkflow);
        opacity: 0.7;
        text-align: center;
      }

      @page {
        @prince-overlay {
          content: flow(watermarkflow);
        }
      }
    </style>
    <button id="download-button" type="button" onclick="downloadDocumentFrom('html')">Download Document</button>
  </body>
</html>

DocRaptor & Node.js

The best way to use DocRaptor with Node.js is directly through our HTTP API. In this example, we'll use the axios module, but you can obviously use any HTTP client you'd like.

Install the Axios Module

npm install axios

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

const axios = require("axios");
const fs = require("fs");

const document_content = `
  <div id="watermark"><img src="https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png" /></div>
  <div style="page-break-after: always;">Page 1</div>
  <div style="page-break-after: always;">Page 2</div>
  <div style="page-break-after: always;">Page 3</div>

  <style>
    #watermark {
      flow: static(watermarkflow);
      opacity: 0.7;
      text-align: center;
    }

    @page {
       @prince-overlay {
          content: flow(watermarkflow);
       }
    }
  </style>
`;

config = {
  url: "https://api.docraptor.com/docs",
  method: "post",
  responseType: "arraybuffer", //IMPORTANT! Required to fetch the binary PDF
  headers: {
    "Content-Type": "application/json"
  },
  data: {
    user_credentials: "YOUR_API_KEY_HERE", // this key works in test mode!
    doc: {
      test: false, // test documents are free but watermarked
      document_type: "pdf",
      document_content: document_content
      // document_url: "https://docraptor.com/examples/invoice.html",
      // javascript: true,
      // prince_options: {
      //   media: "print", // @media 'screen' or 'print' CSS
      //   baseurl: "https://yoursite.com", // the base URL for any relative URLs
      //   }
    }
  }
};

axios(config)
  .then(function(response) {
    fs.writeFile(
      "image-based-watermark.pdf",
      response.data,
      "binary",
      function(writeErr) {
        if (writeErr) throw writeErr;
        console.log("Saved image-based-watermark.pdf!");
      }
    );
  })
  .catch(function(error) {
    // DocRaptor error messages are contained in the response body
    // Since the response is binary encoded, let's decode
    var decoder = new TextDecoder("utf-8");
    console.log(decoder.decode(error.response.data));
  });

Installing the PHP Agent

composer require docraptor/docraptor

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

<?php

require_once __DIR__ . "/vendor/autoload.php";

$docraptor = new DocRaptor\DocApi();
# this key works in test mode!
$docraptor->getConfig()->setUsername("YOUR_API_KEY_HERE");

$document_content = <<<DOCUMENT_CONTENT
  <div id="watermark"><img src="https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png" /></div>
  <div style="page-break-after: always;">Page 1</div>
  <div style="page-break-after: always;">Page 2</div>
  <div style="page-break-after: always;">Page 3</div>

  <style>
    #watermark {
      flow: static(watermarkflow);
      opacity: 0.7;
      text-align: center;
    }

    @page {
       @prince-overlay {
          content: flow(watermarkflow);
       }
    }
  </style>
DOCUMENT_CONTENT;

try {
    $doc = new DocRaptor\Doc();
    $doc->setTest(false); # test documents are free but watermarked
    $doc->setDocumentType("pdf");
    $doc->setDocumentContent($document_content);
    # $doc->setDocumentUrl("https://docraptor.com/examples/invoice.html");
    # $doc->setJavascript(true);
    # $prince_options = new DocRaptor\PrinceOptions();
    # $doc->setPrinceOptions($prince_options);
    # $prince_options->setMedia("print"); # @media 'screen' or 'print' CSS
    # $prince_options->setBaseurl("https://yoursite.com"); # the base URL for any relative URLs

    $response = $docraptor->createDoc($doc);

    # createDoc() returns a binary string
    file_put_contents("image-based-watermark.pdf", $response);
    echo "Successfully created image-based-watermark.pdf!";
} catch (DocRaptor\ApiException $error) {
    echo $error . "\n";
    echo $error->getMessage() . "\n";
    echo $error->getCode() . "\n";
    echo $error->getResponseBody() . "\n";
}

Installing the Python Agent

pip install --upgrade docraptor

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

import docraptor

doc_api = docraptor.DocApi()
# this key works in test mode!
doc_api.api_client.configuration.username = 'YOUR_API_KEY_HERE'

document_content = r"""
    <div id="watermark"><img src="https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png" /></div>
    <div style="page-break-after: always;">Page 1</div>
    <div style="page-break-after: always;">Page 2</div>
    <div style="page-break-after: always;">Page 3</div>

    <style>
      #watermark {
        flow: static(watermarkflow);
        opacity: 0.7;
        text-align: center;
      }

      @page {
         @prince-overlay {
            content: flow(watermarkflow);
         }
      }
    </style>
"""

try:
    response = doc_api.create_doc({
        'test': False,  # test documents are free but watermarked
        'document_type': 'pdf',
        'document_content': document_content,
        # 'document_url': 'https://docraptor.com/examples/invoice.html',
        # 'javascript': True,
        # 'prince_options': # {
        #    'media': 'print', # @media 'screen' or 'print' CSS
        #    'baseurl': 'https://yoursite.com', # the base URL for any relative URLs
        # },
    })

    # create_doc() returns a binary string
    with open('image-based-watermark.pdf', 'w+b') as f:
        binary_formatted_response = bytearray(response)
        f.write(binary_formatted_response)
        f.close()
    print('Successfully created image-based-watermark.pdf!')
except docraptor.rest.ApiException as error:
    print(error.status)
    print(error.reason)
    print(error.body)

Installing the Ruby Agent

Add or require the docraptor gem to your project or script.

Generating the Document

The API key shown here, YOUR_API_KEY_HERE, actually works! Use it for testing without creating an account. The only requirement is test mode must be used (test parameter set to true).

require "docraptor"

DocRaptor.configure do |config|
  config.username = "YOUR_API_KEY_HERE" # this key works in test mode!
end

docraptor = DocRaptor::DocApi.new

document_content = <<~'DOCUMENT_CONTENT'
  <div id="watermark"><img src="https://docraptor-production-cdn.s3.amazonaws.com/tutorials/raptor.png" /></div>
  <div style="page-break-after: always;">Page 1</div>
  <div style="page-break-after: always;">Page 2</div>
  <div style="page-break-after: always;">Page 3</div>

  <style>
    #watermark {
      flow: static(watermarkflow);
      opacity: 0.7;
      text-align: center;
    }

    @page {
       @prince-overlay {
          content: flow(watermarkflow);
       }
    }
  </style>
DOCUMENT_CONTENT

begin
  response = docraptor.create_doc(
    test: false, # test documents are free but watermarked
    document_type: "pdf",
    document_content: document_content,
    # document_url: "https://docraptor.com/examples/invoice.html",
    # javascript: true,
    # prince_options: {
    #   media: "print", # @media 'screen' or 'print' CSS
    #   baseurl: "https://yoursite.com", # the base URL for any relative URLs
    # }
  )

  # create_doc() returns a binary string
  File.write("image-based-watermark.pdf", response, mode: "wb")
  puts "Successfully created image-based-watermark.pdf!"
rescue DocRaptor::ApiError => error
  puts "#{error.class}: #{error.message}"
  puts error.code
  puts error.response_body
  puts error.backtrace[0..3].join("\n")
end