Documentation

Image to PDF in C# and .NET

Overview

The official PDFCrowd .NET client library provides access to the Image to PDF API.

Installation

You can install the client library from NuGet 
nuget install -OutputDirectory packages Pdfcrowd.Official
Clone pdfcrowd-dotnet from GitHub and build the library. 
git clone https://github.com/pdfcrowd/pdfcrowd-dotnet
cd pdfcrowd-dotnet
make.bat # on Windows
make all # on Unix

Quick Start

The examples below cover the basic conversion flow. See additional examples for more scenarios. 

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // Create an API client instance.
            pdfcrowd.ImageToPdfClient client =
                new pdfcrowd.ImageToPdfClient("demo", "demo");

            // Run the conversion and save the result to a file.
            client.convertUrlToFile("https://pdfcrowd.com/static/images/logo.png", "logo.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            System.Console.Error.WriteLine("PDFCrowd Error: " + why);
            throw;
        }
    }
}
using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // Create an API client instance.
            pdfcrowd.ImageToPdfClient client =
                new pdfcrowd.ImageToPdfClient("demo", "demo");

            // Run the conversion and save the result to a file.
            client.convertRawDataToFile(File.ReadAllBytes("/path/to/logo.png"), "logo.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            System.Console.Error.WriteLine("PDFCrowd Error: " + why);
            throw;
        }
    }
}

Authentication

Error Handling

It is recommended that you implement error handling to catch errors the API may return. Effective error handling is vital as it ensures application stability and provides clearer diagnostics. See the example code below for guidance on implementing error handling, and refer to this list of status codes for more information. 

try 
{
    // Call the API 
}
catch(pdfcrowd.Error why) 
{
    // Log the complete error
    System.Console.Error.WriteLine("PDFCrowd Error: " + why);

    // Log the HTTP status code
    System.Console.Error.WriteLine("Status Code: " + why.getStatusCode());

    // Log the reason code
    System.Console.Error.WriteLine("Reason Code: " + why.getReasonCode());

    // Log the error message
    System.Console.Error.WriteLine("Error Message: " + why.getMessage());

    // Log the documentation link
    System.Console.Error.WriteLine("Documentation Link: " + why.getDocumentationLink());
}

Troubleshooting

  • If you are receiving an error, refer to the API Status Codes for more information.
  • Use setDebugLog() and getDebugLogUrl() to obtain detailed information about the conversion process, including load errors, load times, browser console output, etc.
  • Consult the FAQ for answers to common questions.
  • Contact us if you need assistance or if there is a feature you are missing.