PDF to PDF API - PHP

Join multiple PDF files in PHP using the Pdfcrowd API v2. The API is easy to use and the integration takes only a couple of lines of code.

Installation

Download pdfcrowd-4.4.1-php.zip, unzip it and require pdfcrowd.php in your code.

Learn more about other install options (Composer, GitHub).

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key.
Sign up for a Free Trial

Examples

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->addPdfFile("/path/to/cover.pdf");
    $client->addPdfFile("/path/to/proposal.pdf");
    $client->addPdfFile("/path/to/price.pdf");
    $client->addPdfFile("/path/to/contact.pdf");

    // run the conversion and write the result to a file
    $client->convertToFile("offer.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>
<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->addPdfFile("/path/to/cover.pdf");
    $client->addPdfFile("/path/to/proposal.pdf");
    $client->addPdfFile("/path/to/price.pdf");
    $client->addPdfFile("/path/to/contact.pdf");

    // create output file for conversion result
    $output_file = fopen("offer.pdf", "wb");

    // check for a file creation error
    if (!$output_file)
        throw new \Exception(error_get_last()['message']);

    // run the conversion and store the result into a pdf variable
    $pdf = $client->convert();

    // write the pdf into the output file
    $written = fwrite($output_file, $pdf);

    // check for a file write error
    if ($written === false)
        throw new \Exception(error_get_last()['message']);

    // close the output file
    fclose($output_file);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>
<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->addPdfFile("/path/to/cover.pdf");
    $client->addPdfFile("/path/to/proposal.pdf");
    $client->addPdfFile("/path/to/price.pdf");
    $client->addPdfFile("/path/to/contact.pdf");

    // create output stream for conversion result
    $output_stream = fopen("offer.pdf", "wb");

    // check for a file creation error
    if (!$output_stream)
        throw new \Exception(error_get_last()['message']);

    // run the conversion and write the result into the output stream
    $client->convertToStream($output_stream);

    // close the output stream
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>
<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->addPdfRawData(file_get_contents("/path/to/cover.pdf"));
    $client->addPdfRawData(file_get_contents("/path/to/proposal.pdf"));
    $client->addPdfRawData(file_get_contents("/path/to/price.pdf"));
    $client->addPdfRawData(file_get_contents("/path/to/contact.pdf"));

    // run the conversion and write the result to a file
    $client->convertToFile("offer.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>
<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->addPdfRawData(file_get_contents("/path/to/cover.pdf"));
    $client->addPdfFile("/path/to/proposal.pdf");
    $client->addPdfRawData(file_get_contents("/path/to/price.pdf"));
    $client->addPdfFile("/path/to/contact.pdf");

    // run the conversion and write the result to a file
    $client->convertToFile("offer.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>
<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\PdfToPdfClient("your_username", "your_apikey");

    // configure the conversion
    $client->setDebugLog(true);
    $client->addPdfRawData(file_get_contents("/path/to/cover.pdf"));
    $client->addPdfRawData(file_get_contents("/path/to/proposal.pdf"));

    // run the conversion and write the result to a file
    $client->convertToFile("offer.pdf");
    
    // print URL to the debug log
    echo "Debug log url: " . $client->getDebugLogUrl() . "\n";
    
    // print the number of available conversion credits in your account
    echo "Remaining credit count: " . $client->getRemainingCreditCount() . "\n";
    
    // print the number of credits consumed by the conversion
    echo "Consumed credit count: " . $client->getConsumedCreditCount() . "\n";
    
    // print the unique ID of the conversion
    echo "Job id: " . $client->getJobId() . "\n";
    
    // print the total number of pages in the output document
    echo "Page count: " . $client->getPageCount() . "\n";
    
    // print the size of the output in bytes
    echo "Output size: " . $client->getOutputSize() . "\n";
}
catch(\Pdfcrowd\Error $why)
{
    // report the error
    error_log("Pdfcrowd Error: {$why}\n");

    // handle the exception here or rethrow and handle it at a higher level
    throw $why;
}

?>

Tips & Tricks

Error Handling

try 
{
    // call the API 
}
catch(\Pdfcrowd\Error $why) 
{
    // print error
    error_log("Pdfcrowd Error: {$why}\n");

    // print just error code
    error_log("Pdfcrowd Error Code: {$why->getCode()}\n");

    // print just error message
    error_log("Pdfcrowd Error Message: {$why->getMessage()}\n");

    // or handle the error in your way
}

Troubleshooting

API Reference - class PdfToPdfClient

Conversion from PDF to PDF. All setter methods return PdfToPdfClient object unless otherwise specified.

Constructor

function __construct($user_name, $api_key)
Constructor for the Pdfcrowd API client.
Parameter Description Default
user_name
Your username at Pdfcrowd.
api_key
Your API key.

 

PDF Manipulation

function setAction($action)
Specifies the action to be performed on the input PDFs.
Parameter Description Default
action
Allowed values:
  • join
    Concatenate input PDFs into a single one.
  • shuffle
    Collate pages from input PDFs into a single one, take one page at a time from each input PDF. This is useful when combining two scanned documents containing odd and even pages.
join
function convert()
Perform an action on the input files.
Returns
  • byte[] - Byte array containing the output PDF.
function convertToStream($out_stream)
Perform an action on the input files and write the output PDF to an output stream.
Parameter Description Default
out_stream
The output stream that will contain the output PDF.
function convertToFile($file_path)
Perform an action on the input files and write the output PDF to a file.
Parameter Description Default
file_path
The output file path.
The string must not be empty.
function addPdfFile($file_path)
Add a PDF file to the list of the input PDFs.
Parameter Description Default
file_path
The file path to a local PDF file.
The file must exist and not be empty.
function addPdfRawData($pdf_raw_data)
Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another Pdfcrowd converter.

Example in PHP:
$clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl('http://www.example.com'));
Parameter Description Default
pdf_raw_data
The raw PDF data.
The input data must be PDF content.

 

Miscellaneous

function setDebugLog($debug_log)
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
Parameter Description Default
debug_log
Set to true to enable the debug logging.
false
function getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
function getRemainingCreditCount()
Get the number of conversion credits available in your account.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
Returns
  • int - The number of credits.
function getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
function getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
function getPageCount()
Get the total number of pages in the output document.
Returns
  • int - The page count.
function getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.
function setTag($tag)
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
Parameter Description Default
tag
A string with the custom tag.

 

API Client Options

function setUseHttp($use_http)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Parameter Description Default
use_http
Set to true to use HTTP.
false
function setUserAgent($user_agent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
Parameter Description Default
user_agent
The user agent string.
pdfcrowd_php_client/4.4.1 (http://pdfcrowd.com)
function setProxy($host, $port, $user_name, $password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
Parameter Description Default
host
The proxy hostname.
port
The proxy port.
user_name
The username.
password
The password.
function setRetryCount($retry_count)
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
Parameter Description Default
retry_count
Number of retries wanted.
1