CData JDBC Driver for Smartsheet 2019 - Online Help
Questions / Feedback?

Establishing a Connection

CData JDBC Driver for Smartsheet 2019 - Build 19.0.7354

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 2019 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.

Smartsheet supports connections via the following authentication methods:

  • Using the Personal Access Token
  • Using OAuth

Connect using 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.
You can then set the OAuthAccessToken to the token you generated. You will also need to set InitiateOAuth to OFF.

Connect using OAuth

Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, to access your own account or for testing purposes you can instead set the OAuthAccessToken connection property to the Personal Access Token you get when you create an application.

For more information, refer to our Using OAuth Authentication guide.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0