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 from a Connection Pool in Jetty


The Typeform JDBC Driver supports connection pooling: This article shows how to connect faster to Typeform data from Web apps in Jetty.

The CData JDBC driver for Typeform is easy to integrate with Java Web applications. This article shows how to efficiently connect to Typeform data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for Typeform in Jetty.

Configure the JDBC Driver for Salesforce as a JNDI Data Source

Follow the steps below to connect to Salesforce from Jetty.

  1. Enable the JNDI module for your Jetty base. The following command enables JNDI from the command-line:

    java -jar ../start.jar --add-to-startd=jndi
  2. Add the CData and license file, located in the lib subfolder of the installation directory, into the lib subfolder of the context path.

  3. Declare the resource and its scope. Enter the required connection properties in the resource declaration. This example declares the Typeform data source at the level of the Web app, in WEB-INF\jetty-env.xml.

    <Configure id='typeformdemo' class="org.eclipse.jetty.webapp.WebAppContext"> <New id="typeformdemo" class="org.eclipse.jetty.plus.jndi.Resource"> <Arg><Ref refid="typeformdemo"/></Arg> <Arg>jdbc/typeformdb</Arg> <Arg> <New class="cdata.jdbc.api.APIDriver"> <Set name="url">jdbc:api:</Set> <Set name="Profile">C:\profiles\TypeForm.apip</Set> <Set name="Authscheme">OAuth</Set> <Set name="OAuthClientId">your_client_id</Set> <Set name="OAuthClientSecret">your_client_secret</Set> <Set name="CallbackUrl">your_callback_url</Set> <Set name="InitiateOAuth">GETANDREFRESH</Set> </New> </Arg> </New> </Configure>

    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.

  4. Configure the resource in the Web.xml:

    jdbc/typeformdb javax.sql.DataSource Container

  5. You can then access Typeform with a lookup to java:comp/env/jdbc/typeformdb: InitialContext ctx = new InitialContext(); DataSource mytypeform = (DataSource)ctx.lookup("java:comp/env/jdbc/typeformdb");

More Jetty Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more use cases and information, see the Working with Jetty JNDI chapter in the Jetty documentation.