Learn more
 

Ready to get started?

Connect to live data from JotForm with the API Driver

Connect to JotForm

In this article

Related articles

Connect to JotForm Data in JRuby


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

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

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

JRuby natively supports JDBC, so you can easily connect to JotForm 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 JotForm Profile on disk (e.g. C:\profiles\JotForm.apip). Next, set the ProfileSettings connection property to the connection string for JotForm (see below).

JotForm API Profile Settings

You will need to find your JotForm API Key in order to authenticate. To obtain an API Key, go to 'My Account' > 'API Section' > 'Create a New API Key'. Once you've created your new API Key, you can set it in the ProfileSettings connection property.

Custom Enterprise API Domains

Enterprise customers of JotForm are given custom API domains to connect to, rather than the default 'api.jotform.com' domain. If you are an enterprise JotForm customer, then set Domain to you custom API hostname, such as 'your-domain.com' or 'subdomain.jotform.com', inside the ProfileSettings connection property. Conversely, if you do not have a custom domain and still need to connect to 'api.jotform.com', then leave Domain undefined and set only APIKey.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\JotForm.apip;ProfileSettings='APIKey=my_api_key;Domain=my_custom_domain';

Create a JRuby App with Connectivity to JotForm 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 JotForm 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\JotForm.apip;ProfileSettings='APIKey=my_api_key;Domain=my_custom_domain';" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Title FROM Forms") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S APISelect.rb

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