Learn more
 

Ready to get started?

Connect to live data from Klipfolio with the API Driver

Connect to Klipfolio

In this article

Related articles

Connect to Klipfolio Data in Ruby


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

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

Create an ODBC Connection to Klipfolio 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 Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

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 Klipfolio 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, Name FROM DataSources WHERE IsDynamic = 'true'") #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 Klipfolio data with Ruby. To do so, simply run your file from the command line:

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