Skip to main content

Smartsheet API

Eric Elfline
  • Updated

This will require Data Admin privileges to setup and Builder for implementation.

iDashboards is able to connect to a Smartsheet API by using a JDBC driver. A JDBC driver is a software component enabling a Java application to interact with a database. To connect with individual databases, JDBC (Java Database Connectivity API) requires specific drivers for each database. The JDBC driver gives out the connection to the database and implements the protocol for transferring the query and result between the client and the database. iDashboards implements native protocols and does not require additional software installed on the driver host. In other words, iDashboards provides driver connectivity with the JDBC Data Source via the specified driver. This document explains a step-by-step procedure to create the Data Source with a Premium Data Connector.

CDATA for SmartSheet

CData JDBC Driver for Smartsheet is where we get the documentation on making this connection, however, the Premium Data Connectors are not a straight forward process which is why we make articles like this to help you make the connections more easily. This one requires a few steps, with a few different links to get very specific pieces of information to make this connection within iDashboards. The Smartsheet API  is part of the Premium Data Connectors if you do not have these please contact your Client Success Manager. 

Create a Smartsheet App

  1. Register your developer account
  2. Enter your email address and click Register Developer Account
  3. You will be sent and email with an activation link you must Click the link
  4. The link will take you to a get started page where you will create you account passwordsmartsheet1.PNG
  5. After you enter your password and click Continue you'll be taken to Developer Tools
  6. Click Edit Developer Profile and fill in your company name and website.
  7. When you're finished click Create New Appsmartsheet2.PNG

  8. Fill in all the required URLs

  9. Check Publish App

  10. Upload a logo if you choose and Savesmartsheet3.PNG

  11. After you Save, a window will pop up with your App ID and App secret copy them to a text file

Obtaining your OAuth Access Token

  1. On the Smartsheet developer home page, in the upper right corner, click the Avatar Icon 
  2. Select App and Integrations....
  3. In Personal Settings select API Access
  4. Then click Generate New Access Tokensmartsheet4.PNG
  5.  Name the token, click ok then, copy the token to your text file. 

Obtaining and Entering Credentials

In this section we'll be building the connection string to be used later when setting up the data source connection.

  1. Place the Smartsheet driver cdata.jdbc.smartsheet.jar in the following location:
    • C:\Program Files\iDashboards_SRV\ivizgroup\drivers
  2. Double click the driver and it should open the drivers connection properties.
    1. If clicking doesn't work for you, you can do this via command line:
      • cd C:\Program Files\iDashboards_SRV\ivizgroup\drivers
      • java -jar cdata.jdbc.smartsheet.jarsmartsheet.PNG
  3. Scroll to the OAuth section of the connection properties and filling in the following: 
    1. Callback/Redirect URL
      • http://<ServerName>:6600/idbdata/console/api/callback
    2. Default Port: 6700
    3. Set Initiate OAuth to GETANDREFRESH
    4. OAuth Access Token
      • Obtained in Obtaining your OAuth Access Token
        • Copy and paste from your text file
    5. Client ID and Client Secret: Obtained at the end of Create your App in Smartsheet
      • Copy and paste from your text file
    6. OAuth Verifier: Same as the callback URL:
      • http://<ServerName>:6600/idbdata/console/api/callback
  4. Once these fields are filled in click Test Connection.
  5. When your test comes back successful, click Copy to Clipboard
  6. Paste the connection string into a text file to use in Creating the Data Connection

Data Connection

Follow the steps below to set up a data source in iDashboards Admin or Data Hub

  1. Select Data Sources
  2. Then New
  3. Select the Data Source Type: Generic JDBC 
  4. In the Create a Data Source window fill in the highlighted fields:mceclip0.png

    Database URL*: Enter in the connection string you created in Obtaining and Entering Credentials

    JDBC Driver Class: cdata.jdbc.smartsheet.SmartsheetDriver

  5. Click Save

It will look similar to below before you click Save:

smartsheet5.PNG

For More Information:

Disclaimer: iDashboards Technical Support Engineers are not proficient in the Management and Integration of every API that exists as new APIs are being created everyday with each company that wants to provide seamless integration with other software. However, we do our best to help you make these connections because we want to assist you in your success. If you do not see an article for a connection you would like to make please contact iDashboards Support and know that it will take a bit of time to figure out what is necessary for this integration.

If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.

Comments

0 comments

Please sign in to leave a comment.