Connect to Reply.io Data in JRuby
JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Reply.io makes it easy to integrate connectivity to live Reply.io data in JRuby. This article shows how to create a simple JRuby app that connects to Reply.io data, executes a query, and displays the results.
Configure a JDBC Connection to Reply.io Data
Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Reply.io\lib).
JRuby natively supports JDBC, so you can easily connect to Reply.io and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.
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';
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Reply.io JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Fill in the connection properties and copy the connection string to the clipboard.
Below is a typical JDBC connection string for Reply.io:
jdbc:api:Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
Create a JRuby 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:
require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for Reply.io 2018/lib/cdata.jdbc.api.jar'
url = "jdbc:api:Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT , FROM BillingInfo")
while (rs.next) do
puts rs.getString(1) + ' ' + rs.getString(2)
end
With the file completed, you are ready to display your Reply.io data with JRuby. To do so, simply run your file from the command line:
jruby -S APISelect.rb
Writing SQL-92 queries to Reply.io allows you to quickly and easily incorporate Reply.io data into your own JRuby applications. Download a free trial today!