Image to Image API - PHP

Convert between various image formats 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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertFileToFile("/path/to/logo.png", "logo.jpg");
}
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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "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 an image variable
    $image = $client->convertFile("/path/to/logo.png");

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

    // 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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "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->convertFileToStream("/path/to/logo.png", $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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertUrlToFile("http://pdfcrowd.com/static/images/logo.png", "logo.jpg");
}
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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "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 an image variable
    $image = $client->convertUrl("http://pdfcrowd.com/static/images/logo.png");

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

    // 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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "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->convertUrlToStream("http://pdfcrowd.com/static/images/logo.png", $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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertRawDataToFile(file_get_contents("/path/to/logo.png"), "logo.jpg");
}
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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "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 an image variable
    $image = $client->convertRawData(file_get_contents("/path/to/logo.png"));

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

    // 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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "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->convertRawDataToStream(file_get_contents("/path/to/logo.png"), $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\ImageToImageClient("your_username", "your_apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");
    $client->setDebugLog(true);

    // run the conversion and write the result to a file
    $client->convertFileToFile("/path/to/logo.png", "logo.jpg");
    
    // 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 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 ImageToImageClient

Conversion from one image format to another image format. All setter methods return ImageToImageClient 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.

 

Conversion Input

function convertUrl($url)
Convert an image.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output.
function convertUrlToStream($url, $out_stream)
Convert an image and write the result to an output stream.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
out_stream
The output stream that will contain the conversion output.
function convertUrlToFile($url, $file_path)
Convert an image and write the result to a local file.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
file_path
The output file path.
The string must not be empty.
function convertFile($file)
Convert a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
Returns
  • byte[] - Byte array containing the conversion output.
function convertFileToStream($file, $out_stream)
Convert a local file and write the result to an output stream.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
out_stream
The output stream that will contain the conversion output.
function convertFileToFile($file, $file_path)
Convert a local file and write the result to a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
file_path
The output file path.
The string must not be empty.
function convertRawData($data)
Convert raw data.
Parameter Description Default
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output.
function convertRawDataToStream($data, $out_stream)
Convert raw data and write the result to an output stream.
Parameter Description Default
data
The raw content to be converted.
out_stream
The output stream that will contain the conversion output.
function convertRawDataToFile($data, $file_path)
Convert raw data to a file.
Parameter Description Default
data
The raw content to be converted.
file_path
The output file path.
The string must not be empty.

 

Conversion Format

function setOutputFormat($output_format)
The format of the output file.
Parameter Description Default
output_format
Allowed values:
  • png
  • jpg
  • gif
  • tiff
  • bmp
  • ico
  • ppm
  • pgm
  • pbm
  • pnm
  • psb
  • pct
  • ras
  • tga
  • sgi
  • sun
  • webp
png

 

Image operations

Settings used for operations with images.

function setResize($resize)
Resize the image.
Parameter Description Default
resize
The resize percentage or new image dimensions.
100%
Examples:
  • setResize("200%")
  • setResize("1024x768")
function setRotate($rotate)
Rotate the image.
Parameter Description Default
rotate
The rotation specified in degrees.
0

 

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 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.
function setHttpProxy($http_proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Parameter Description Default
http_proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333")
function setHttpsProxy($https_proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Parameter Description Default
https_proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

 

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