PDF to PDF API - Ruby

Join multiple PDF files in Ruby using the Pdfcrowd API v2. The API is easy to use and the integration takes only a couple of lines of code.

Installation

Install the client library from rubygems.org
gem install pdfcrowd

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

require 'pdfcrowd'

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

    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # 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 into the output file
    output_file.write(pdf)

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

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # configure the conversion
    client.addPdfFile("/path/to/proposal.pdf")
    client.setPageWatermark("/path/to/watermark.pdf")

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

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # configure the conversion
    client.addPdfFile("/path/to/not_linearized.pdf")
    client.setLinearize(true)

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

    # handle the exception here or rethrow and handle it at a higher level
    raise
end
require 'pdfcrowd'

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

    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # handle the exception here or rethrow and handle it at a higher level
    raise
end

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 in your way
end

Troubleshooting

API Reference - class PdfToPdfClient

Conversion from PDF to PDF. All setter methods return PdfToPdfClient object unless otherwise specified.

Constructor

def initialize(user_name, api_key)
Constructor for the Pdfcrowd API client.
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.
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.
Default: join
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.
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.
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.
file_path
The file path to a local PDF file.
The file must exist and not be empty.
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'));
pdf_raw_data
The raw PDF data.
The input data must be PDF content.

 

Watermark & Background

def setPageWatermark(page_watermark)
Apply the first page of the watermark PDF to every page of the output PDF.
page_watermark
The file path to a local watermark PDF file.
The file must exist and not be empty.
def setPageWatermarkUrl(page_watermark_url)
Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
page_watermark_url
The supported protocols are http:// and https://.
Examples:
  • setPageWatermarkUrl("http://myserver.com/watermark.pdf")
def setMultipageWatermark(multipage_watermark)
Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
multipage_watermark
The file path to a local watermark PDF file.
The file must exist and not be empty.
def setMultipageWatermarkUrl(multipage_watermark_url)
Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
multipage_watermark_url
The supported protocols are http:// and https://.
Examples:
  • setMultipageWatermarkUrl("http://myserver.com/watermark.pdf")
def setPageBackground(page_background)
Apply the first page of the specified PDF to the background of every page of the output PDF.
page_background
The file path to a local background PDF file.
The file must exist and not be empty.
def setPageBackgroundUrl(page_background_url)
Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
page_background_url
The supported protocols are http:// and https://.
Examples:
  • setPageBackgroundUrl("http://myserver.com/background.pdf")
def setMultipageBackground(multipage_background)
Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
multipage_background
The file path to a local background PDF file.
The file must exist and not be empty.
def setMultipageBackgroundUrl(multipage_background_url)
Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
multipage_background_url
The supported protocols are http:// and https://.
Examples:
  • setMultipageBackgroundUrl("http://myserver.com/background.pdf")

 

PDF Format

Miscellaneous values for PDF output.

def setLinearize(linearize)
Create linearized PDF. This is also known as Fast Web View.
linearize
Set to true to create linearized PDF.
Default: false
def setEncrypt(encrypt)
Encrypt the PDF. This prevents search engines from indexing the contents.
encrypt
Set to true to enable PDF encryption.
Default: false
def setUserPassword(user_password)
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
user_password
The user password.
def setOwnerPassword(owner_password)
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
owner_password
The owner password.
def setNoPrint(no_print)
Disallow printing of the output PDF.
no_print
Set to true to set the no-print flag in the output PDF.
Default: false
def setNoModify(no_modify)
Disallow modification of the output PDF.
no_modify
Set to true to set the read-only only flag in the output PDF.
Default: false
def setNoCopy(no_copy)
Disallow text and graphics extraction from the output PDF.
no_copy
Set to true to set the no-copy flag in the output PDF.
Default: false

 

Viewer Preferences

These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.

def setPageLayout(page_layout)
Specify the page layout to be used when the document is opened.
page_layout
Allowed values:
  • single-page
    Display one page at a time.
  • one-column
    Display the pages in one column.
  • two-column-left
    Display the pages in two columns, with odd-numbered pages on the left.
  • two-column-right
    Display the pages in two columns, with odd-numbered pages on the right.
def setPageMode(page_mode)
Specify how the document should be displayed when opened.
page_mode
Allowed values:
  • full-screen
    Full-screen mode.
  • thumbnails
    Thumbnail images are visible.
  • outlines
    Document outline is visible.
def setInitialZoomType(initial_zoom_type)
Specify how the page should be displayed when opened.
initial_zoom_type
Allowed values:
  • fit-width
    The page content is magnified just enough to fit the entire width of the page within the window.
  • fit-height
    The page content is magnified just enough to fit the entire height of the page within the window.
  • fit-page
    The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
def setInitialPage(initial_page)
Display the specified page when the document is opened.
initial_page
Must be a positive integer number.
def setInitialZoom(initial_zoom)
Specify the initial page zoom in percents when the document is opened.
initial_zoom
Must be a positive integer number.
def setHideToolbar(hide_toolbar)
Specify whether to hide the viewer application's tool bars when the document is active.
hide_toolbar
Set to true to hide tool bars.
Default: false
def setHideMenubar(hide_menubar)
Specify whether to hide the viewer application's menu bar when the document is active.
hide_menubar
Set to true to hide the menu bar.
Default: false
def setHideWindowUi(hide_window_ui)
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
hide_window_ui
Set to true to hide ui elements.
Default: false
def setFitWindow(fit_window)
Specify whether to resize the document's window to fit the size of the first displayed page.
fit_window
Set to true to resize the window.
Default: false
def setCenterWindow(center_window)
Specify whether to position the document's window in the center of the screen.
center_window
Set to true to center the window.
Default: false
def setDisplayTitle(display_title)
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
display_title
Set to true to display the title.
Default: false
def setRightToLeft(right_to_left)
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
right_to_left
Set to true to set right-to-left reading order.
Default: false

 

Miscellaneous

def 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.
debug_log
Set to true to enable the debug logging.
Default: false
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.
This method can only be called after a call to one of the convertXYZ methods.
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.
def 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.
tag
A string with the custom tag.

 

API Client Options

def setUseHttp(use_http)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
use_http
Set to true to use HTTP.
Default: false
def setUserAgent(user_agent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
user_agent
The user agent string.
Default: pdfcrowd_ruby_client/4.11.0 (http://pdfcrowd.com)
def setProxy(host, port, user_name, password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host
The proxy hostname.
port
The proxy port.
user_name
The username.
password
The password.
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.
retry_count
Number of retries wanted.
Default: 1