Connect to PayPal Data in Ruby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

PayPal ODBC Driver

The PayPal ODBC Driver is a powerful tool that allows you to connect with live data from PayPal, directly from any applications that support ODBC connectivity.

Access PayPal Transactions, Orders, Sales, Invoices, etc. through a standard ODBC Driver interface.



Connect to PayPal data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for PayPal makes it easy to integrate connectivity to live PayPal data in Ruby. This article shows how to create a simple Ruby app that connects to PayPal data, executes a query, and displays the results.

Create an ODBC Connection to PayPal Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

  • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
  • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

For testing purposes you can set UseSandbox to true and use sandbox credentials.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby App with Connectivity to PayPal Data

Create a new Ruby file (for example: PayPalSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData PayPal Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Date, GrossAmount FROM Transactions") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

With the file completed, you are ready to display your PayPal data with Ruby. To do so, simply run your file from the command line:

ruby PayPalSelect.rb Writing SQL-92 queries to PayPal allows you to quickly and easily incorporate PayPal data into your own Ruby applications. Download a free trial today!