Connect to Reply.io Data in Ruby
The CData API Driver for ODBC makes it easy to integrate connectivity to live Reply.io data in Ruby. This article shows how to create a simple Ruby app that connects to Reply.io data, executes a query, and displays the results.
Create an ODBC Connection to Reply.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.
The Reply.io API uses API Key authentication via the x-api-key request header.
Using API Key Authentication
Your Reply.io API key is required to create a connection. To obtain your API key:
- Log into your Reply.io account.
- Click your profile icon and select Settings.
- Navigate to the API section.
- Copy your API Key.
After obtaining your API key, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Reply.io API key.
- UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.
Example connection string:
Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_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 Reply.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 , FROM BillingInfo WHERE = ''")
#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 Reply.io data with Ruby. To do so, simply run your file from the command line:
ruby APISelect.rbWriting SQL-92 queries to Reply.io allows you to quickly and easily incorporate Reply.io data into your own Ruby applications. Download a free trial today!