Connect to Respond.io Data in Ruby

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Respond.io data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

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

Create an ODBC Connection to Respond.io 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.

Start by setting the Profile connection property to the location of the Respondio Profile on disk (e.g. C:\profiles\Respondio.apip). Next, set the ProfileSettings connection property to the connection string for Respondio (see below).

Respondio API Profile Settings

Respond.io uses API key authentication. To obtain an API key:

  1. Log in to your Respond.io account.
  2. Navigate to Settings in your workspace.
  3. Select Developer under the Integrations section.
  4. Copy the API key displayed on the page.

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

  • APIKey: Set this to your Respond.io API key.

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 Respond.io Data

Create a new Ruby file (for example: APISelect.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 API Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Email FROM Contacts WHERE Identifier = 'id:438180634'")

#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 Respond.io data with Ruby. To do so, simply run your file from the command line:


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

Ready to get started?

Connect to live data from Respond.io with the API Driver

Connect to Respond.io