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 JRuby


Create a simple JRuby app with access to live Klipfolio data.

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

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

JRuby natively supports JDBC, so you can easily connect to Klipfolio 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 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.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';

Create a JRuby 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:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Klipfolio 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Name FROM DataSources") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S APISelect.rb

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