Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

PDF to PDF - Ruby SDK

Installation

You can install the client library from rubygems.org
 $ gem install pdfcrowd

You can learn more install options here.

The API client library si common for all Pdfcrowd converters.

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. You can find the API key in your account page.

Getting Started

Join PDF Files

Join 4 local PDF files together to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "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')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Join 4 local PDF files together to in-memory PDF

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "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 = open("offer.pdf", "wb")

    # run the conversion and store the result into a pdf variable
    pdf = client.convert()

    # write the pdf the into the output file
    output_file.write(pdf)

    # close the output file
    output_file.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Join 4 local PDF files together and write the resulting PDF to an output stream

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "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 = open("offer.pdf", "wb")

    # run the conversion and write the result into the output stream
    client.convertToStream(output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Join In-Memory PDFs

Join 4 in-memory PDFs together to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "apikey")

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/contact.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Join 2 in-memory PDFs together with 2 local PDF files to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "apikey")

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfFile("/path/to/proposal.pdf")
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfFile("/path/to/contact.pdf")

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Conversion Info

Get info about the current conversion

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::PdfToPdfClient.new("username", "apikey")

    # configure the conversion
    client.setDebugLog(true)
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
    
    # print URL to the debug log
    puts "Debug log url: #{client.getDebugLogUrl()}"
    
    # print the number of available conversion credits in your account
    puts "Remaining credit count: #{client.getRemainingCreditCount()}"
    
    # print the number of credits consumed by the conversion
    puts "Consumed credit count: #{client.getConsumedCreditCount()}"
    
    # print the unique ID of the conversion
    puts "Job id: #{client.getJobId()}"
    
    # print the total number of pages in the output document
    puts "Page count: #{client.getPageCount()}"
    
    # print the size of the output in bytes
    puts "Output size: #{client.getOutputSize()}"
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

API Reference - class PdfToPdfClient

Conversion from PDF to PDF.

Constructor

def initialize(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

def 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
Returns
  • PdfToPdfClient - The converter object.
def convert()
Perform an action on the input files.
Returns
  • byte[] - Byte array containing the output PDF.
def 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.
def 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.
def 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.
Returns
  • PdfToPdfClient - The converter object.
def 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.
Returns
  • PdfToPdfClient - The converter object.

 

Miscellaneous

def setDebugLog(debug_log)
Turn on the debug logging.
Parameter Description Default
debug_log
Set to true to enable the debug logging.
false
Returns
  • PdfToPdfClient - The converter object.
def getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
def 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.
def getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
def getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
def getPageCount()
Get the total number of pages in the output document.
Returns
  • int - The page count.
def getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.

 

API Client Options

def 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
Returns
  • PdfToPdfClient - The converter object.
def 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_ruby_client/4.2 (http://pdfcrowd.com)
Returns
  • PdfToPdfClient - The converter object.
def 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.
Returns
  • PdfToPdfClient - The converter object.
def 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
Returns
  • PdfToPdfClient - The converter object.

 

Error Handling

begin 
    # call the API 
rescue Pdfcrowd::Error => why 
    # print error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # print just error code
    STDERR.puts "Pdfcrowd Error Code: #{why.getCode()}"

    # print just error message
    STDERR.puts "Pdfcrowd Error Message: #{why.getMessage()}"

    # or handle the error by your way
end