PDF to Image / Ruby Guide

Overview

This page serves as a guide for using the PDFCrowd API to convert PDF into images in Ruby applications.

gem install pdfcrowd

git clone https://github.com/pdfcrowd/pdfcrowd-ruby
cd pdfcrowd-ruby
make dist
gem install pdfcrowd-6.5.2.gem

Quick Start

Below are Ruby examples to help you quickly get started with the API. Explore our additional examples for more insights.

For a multi-page PDF, the API returns a ZIP archive containing an image for each page. For a single-page PDF, the output is directly an image (e.g., PNG). To determine the output format, use isZippedOutput(). You can enforce the use of a ZIP archive by using setForceZip().

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::PdfToImageClient.new("USERNAME", "APIKEY")

    # If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png")
    client.setForceZip(true)

    # Run the conversion and save the result to a file.
    client.convertFileToFile("/path/to/invoice.pdf", "invoice.zip")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::PdfToImageClient.new("USERNAME", "APIKEY")

    # If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png")
    client.setForceZip(true)

    # Run the conversion and save the result to a file.
    client.convertUrlToFile("https://pdfcrowd.com/static/pdf/apisamples/invoice.pdf", "invoice.zip")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::PdfToImageClient.new("USERNAME", "APIKEY")

    # If unsure whether the input is a single-page file, enforce ZIP output.
    client.setOutputFormat("png")
    client.setForceZip(true)

    # Run the conversion and save the result to a file.
    client.convertRawDataToFile(open('/path/to/hello_world.pdf', 'rb').read(), "invoice.zip")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

Authentication

The API requires authentication using your PDFCrowd username and API key. To get started quickly, you can use these demo credentials for testing without registering:

• Username: USERNAME
• API key: APIKEY

To get your own API credentials, you can start a free trial or purchase a PDFCrowd license.

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.

begin 
    # Call the API 
rescue Pdfcrowd::Error => why 
    # Log the complete error
    STDERR.puts "PDFCrowd Error: #{why}"

    # Log the HTTP status code
    STDERR.puts "Status Code: #{why.getStatusCode()}"

    # Log the reason code
    STDERR.puts "Reason Code: #{why.getReasonCode()}"

    # Log the error message
    STDERR.puts "Error Message: #{why.getMessage()}"

    # Log the documentation link
    STDERR.puts "Documentation Link: #{why.getDocumentationLink()}"
end

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.

API Method Reference

Refer to the PDF to Image Ruby Reference for a description of all API methods.