Connect to Aircall Data in JRuby

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a simple JRuby app with access to live Aircall data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Aircall makes it easy to integrate connectivity to live Aircall data in JRuby. This article shows how to create a simple JRuby app that connects to Aircall data, executes a query, and displays the results.

Configure a JDBC Connection to Aircall 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 Aircall\lib).

JRuby natively supports JDBC, so you can easily connect to Aircall and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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

Aircall API Profile Settings

In Aircall, go to your company settings and create a new API key to receive an API ID and API token. Combine them as

APIId:APIToken
for the APIKey property.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Aircall 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 Aircall:

jdbc:api:Profile=C:\profiles\Aircall.apip;ProfileSettings='APIKey=your_api_id:your_api_token';

Create a JRuby App with Connectivity to Aircall 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 Aircall 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Aircall.apip;ProfileSettings='APIKey=your_api_id:your_api_token';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Direction FROM Calls")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

Writing SQL-92 queries to Aircall allows you to quickly and easily incorporate Aircall data into your own JRuby applications. Download a free trial today!

Ready to get started?

Connect to live data from Aircall with the API Driver

Connect to Aircall