Image to PDF API - .Net

Convert various image formats to PDF in .Net 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-dotnet.zip, unzip it and add a reference to pdfcrowd.dll to your project.

Learn more about other install options.

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

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/logo.png", "logo.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output file for conversion result
            FileStream outputFile = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and store the result into a pdf variable
            byte[] pdf = client.convertFile("/path/to/logo.png");

            // write the pdf into the output file
            outputFile.Write(pdf, 0, pdf.Length);

            // close the output file
            outputFile.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output stream for conversion result
            FileStream outputStream = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertFileToStream("/path/to/logo.png", outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://pdfcrowd.com/static/images/logo.png", "logo.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output file for conversion result
            FileStream outputFile = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and store the result into a pdf variable
            byte[] pdf = client.convertUrl("http://pdfcrowd.com/static/images/logo.png");

            // write the pdf into the output file
            outputFile.Write(pdf, 0, pdf.Length);

            // close the output file
            outputFile.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output stream for conversion result
            FileStream outputStream = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertUrlToStream("http://pdfcrowd.com/static/images/logo.png", outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // run the conversion and write the result to a file
            client.convertRawDataToFile(File.ReadAllBytes("/path/to/logo.png"), "logo.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output file for conversion result
            FileStream outputFile = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and store the result into a pdf variable
            byte[] pdf = client.convertRawData(File.ReadAllBytes("/path/to/logo.png"));

            // write the pdf into the output file
            outputFile.Write(pdf, 0, pdf.Length);

            // close the output file
            outputFile.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // create output stream for conversion result
            FileStream outputStream = new FileStream("logo.pdf", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertRawDataToStream(File.ReadAllBytes("/path/to/logo.png"), outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.ImageToPdfClient client = new pdfcrowd.ImageToPdfClient(
                "your_username", "your_apikey");

            // configure the conversion
            client.setDebugLog(true);

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/logo.png", "logo.pdf");
            
            // print URL to the debug log
            System.Console.WriteLine("Debug log url: " + client.getDebugLogUrl());
            
            // print the number of available conversion credits in your account
            System.Console.WriteLine("Remaining credit count: " + client.getRemainingCreditCount());
            
            // print the number of credits consumed by the conversion
            System.Console.WriteLine("Consumed credit count: " + client.getConsumedCreditCount());
            
            // print the unique ID of the conversion
            System.Console.WriteLine("Job id: " + client.getJobId());
            
            // print the size of the output in bytes
            System.Console.WriteLine("Output size: " + client.getOutputSize());
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

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

Tips & Tricks

Error Handling

try 
{
    // call the API 
}
catch(pdfcrowd.Error why) 
{
    // print error
    System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

    // print just error code
    System.Console.Error.WriteLine("Pdfcrowd Error Code: " + why.getCode());

    // print just error message
    System.Console.Error.WriteLine("Pdfcrowd Error Message: " + why.getMessage());

    // or handle the error in your way
}

Troubleshooting

API Reference - class ImageToPdfClient

Conversion from an image to PDF. All setter methods return ImageToPdfClient object unless otherwise specified.

Constructor

public ImageToPdfClient(string userName, string apiKey)
Constructor for the Pdfcrowd API client.
Parameter Description Default
userName
Your username at Pdfcrowd.
apiKey
Your API key.

 

Conversion Input

public byte[] convertUrl(string 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.
public void convertUrlToStream(string url, Stream outStream)
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://.
outStream
The output stream that will contain the conversion output.
public void convertUrlToFile(string url, string filePath)
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://.
filePath
The output file path.
The string must not be empty.
public byte[] convertFile(string 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.
public void convertFileToStream(string file, Stream outStream)
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.
outStream
The output stream that will contain the conversion output.
public void convertFileToFile(string file, string filePath)
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.
filePath
The output file path.
The string must not be empty.
public byte[] convertRawData(byte[] data)
Convert raw data.
Parameter Description Default
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output.
public void convertRawDataToStream(byte[] data, Stream outStream)
Convert raw data and write the result to an output stream.
Parameter Description Default
data
The raw content to be converted.
outStream
The output stream that will contain the conversion output.
public void convertRawDataToFile(byte[] data, string filePath)
Convert raw data to a file.
Parameter Description Default
data
The raw content to be converted.
filePath
The output file path.
The string must not be empty.

 

Image operations

Settings used for operations with images.

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

 

Miscellaneous

public ImageToPdfClient setDebugLog(bool debugLog)
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
debugLog
Set to true to enable the debug logging.
false
public string getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
public int 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.
public int getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
public string getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
public int getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.
public ImageToPdfClient setTag(string 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.
public ImageToPdfClient setHttpProxy(string httpProxy)
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
httpProxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333")
public ImageToPdfClient setHttpsProxy(string httpsProxy)
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
httpsProxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

 

API Client Options

public ImageToPdfClient setUseHttp(bool useHttp)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Parameter Description Default
useHttp
Set to true to use HTTP.
false
public ImageToPdfClient setUserAgent(string userAgent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
Parameter Description Default
userAgent
The user agent string.
pdfcrowd_dotnet_client/4.4.1 (http://pdfcrowd.com)
public ImageToPdfClient setProxy(string host, int port, string userName, string 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.
userName
The username.
password
The password.
public ImageToPdfClient setRetryCount(int retryCount)
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
retryCount
Number of retries wanted.
1