View all our articles

Accessing secured pages in Ruby with HttpParty

In this guide, we'll show you how to access secured page (protected by basic authentication) using Ruby and the HttpParty library to convert them to PDF using PDFShift's API.

When you're converting a document, you might want to access a secured page (protected by basic authentication) to convert it to PDF. This can be done by setting the auth parameter to the request.

require 'httparty'
require 'json'

# You can get an API key at
api_key = 'sk_xxxxxxxxxxxx'

params = {
    'source' => '',
    # You can set a basic authentication by passing the "auth" property which contains a username and password
    'auth' => {
        'username' => 'user',
        'password' => 'password'

response =
    body: params.to_json,
    headers: {
        'Content-Type' => 'application/json',
        'Authorization' => "Basic #{Base64.strict_encode64("api:#{api_key}")}"

# Check for successful response
unless response.success?
    raise "Request failed with status code #{response.code}: #{response.body}"

# write response to a file nammed "result.pdf"'result.pdf', 'wb') { |f| f.write(response.body) }

# Print a success message
puts 'The PDF document was generated and saved to result.pdf'

This allows you to protect your documents from any visitors while allowing PDFShift to access the page and convert it to PDF.

For further details on the auth property and its usage, please refer to our dedicated documentation.

We hope this guide was helpful. If you have any questions or noticed any issues on the code above,
feel free to drop us a line.