Learn more
 

Ready to get started?

Connect to live data from Typeform with the API Driver

Connect to Typeform

In this article

Related articles

Connect to Typeform Data in JRuby


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

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

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

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

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

  • CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
  • CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
  • Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
  • Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the Client Id that is specified in your app settings.
  • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Typeform 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 Typeform 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Title FROM Tags") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S APISelect.rb

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