JDBC Driver for Smartsheet

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Smartsheet consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example: 
    cdata.jdbc.smartsheet.SmartsheetDriver
  • Provide the JDBC URL. For example: 
    jdbc:smartsheet:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;

or

jdbc:cdata:smartsheet:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:smartsheet:" or "jdbc:cdata:smartsheet:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Smartsheet

Smartsheet supports connections via the following authentication methods:

  • Using the Personal Access Token
  • Using OAuth

Personal Access Token

Use the personal token to test and to access your own data. To obtain the personal token, follow the steps below:

  1. Log into Smartsheet.
  2. Click Account and select Personal Settings.
  3. Click API Access and use the form to generate new access tokens or manage existing access tokens.
Set the AuthScheme to PersonalAccessToken. You can then set the PersonalAccessToken to the token you generated.

OAuth

Smartsheet supports OAuth authentication only. Regardless of whether you are authenticating from the Web, a Desktop, or a Headless Server, you must set AuthScheme to OAuth, and you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

The following subsections provide details about authenticating from a desktop application, the web, or a headless machine, via a custom OAuth application.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret that was assigned when you registered your application.
  • CallbackURL: The redirect URI that was defined when you registered your application.
When you connect, the driver opens Smartsheet's OAuth endpoint in your default browser.

Log in and grant permissions to the application. The driver then completes the OAuth process:

  1. The driver obtains an access token from Smartsheet and uses it to request data.
  2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
When the access token expires, the driver refreshes the access token automatically.

Web Applications

To authenticate from the web with the credentials for a custom OAuth application, you must register a custom OAuth application with Smartsheet. You can then use the driver to get and manage the OAuth token values.

Get the OAuth access token:

To obtain the OAuthAccessToken set the following connection properties:

  • OAuthClientId: The client Id in your application settings.
  • OAuthClientSecret: The client secret in your application settings.

To complete the OAuth exchange, call stored procedures as follows:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
  2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic refresh of the OAuth access token:

If you want the driver to refresh the OAuth access token automatically, do the following.

The first time you connect to data, set the following connection parameters:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: The client Id in your application settings.
  • OAuthClientSecret: The client secret in your application settings.
  • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
  • OAuthSettingsLocation: The path where you want the driver to save OAuth values that persist across connections.

On subsequent data connections, set the following connection parameters:

  • InitiateOAuth
  • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set the following connection properties:

    • OAuthClientId: The Client Id in your application settings.
    • OAuthClientSecret: The Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to authenticate via OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
  • Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

  1. Set the following properties:
    • InitiateOAuth: OFF.
    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.
  2. Use the appropriate CalllbackURL to call the GetOAuthAuthorizationURL stored procedure.
  3. Copy the returned URL into a browser and open the page.
  4. Log in and grant permissions to the driver. You are redirected to the redirect URI.
  5. Record the code parameter that is appended to the redirect URI. You will use it later, when you set up the OAuthVerifier connection property.
  6. To exchange the OAuth verifier code for OAuth refresh and access tokens, set the following connection properties, which provide the OAuth authentication values:
    • InitiateOAuth: REFRESH.
    • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthClientId: The client Id in your custom OAuth application settings.
    • OAuthClientSecret: The client secret in the custom OAuth application settings.
    • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
  7. Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.
    • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Before connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as previously described above, in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is "OAuthSettings.txt".

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.

Synch Connections

Before you connect, set the following variables:

  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Smartsheet to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

  • Extracts the access token from the callback URL.
  • Obtains a new access token when the old one expires.
  • Saves OAuth values so that they persist across connections.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839