Access Typeform Data in Mule Applications Using the CData JDBC Driver



Create a simple Mule Application that uses HTTP and SQL with CData JDBC drivers to create a JSON endpoint for Typeform data.

The CData API Driver for JDBC connects Typeform data to Mule applications enabling read functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Typeform data.

This article demonstrates how to use the CData API Driver for JDBC inside of a Mule project to create a Web interface for Typeform data. The application created allows you to request Typeform data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a Database Select Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties.
    • Set Connection to "Generic Connection"
    • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.api.jar).
    • Set the URL to the connection string for Typeform

      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.

    • Set the Driver class name to cdata.jdbc.api.APIDriver.
    • Click Test Connection.
  6. Set the SQL Query Text to a SQL query to request Typeform data. For example: SELECT Id, Title FROM Tags WHERE SettingsIsPublic = 'true'
  7. Add a Transform Message Component to the flow.
  8. Set the Output script to the following to convert the payload to JSON:
    %dw 2.0
    output application/json
    ---
    payload
            
  9. To view your Typeform data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Typeform data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Typeform data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Typeform and see the CData difference in your Mule Applications today.

Ready to get started?

Connect to live data from Typeform with the API Driver

Connect to Typeform