Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

Integrate Harvest with External Services using SnapLogic



Use CData JDBC drivers in SnapLogic to integrate Harvest with External Services.

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Harvest, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Harvest data. When platforms issue complex SQL queries to Harvest, the driver pushes supported SQL operations, like filters and aggregations, directly to Harvest and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Harvest data using native data types.

Connect to Harvest in SnapLogic

To connect to Harvest data in SnapLogic, download and install the CData Harvest JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData API Driver for JDBC/lib by default).

Upload the Harvest JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Harvest.

  1. Navigate to the Designer tab
  2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
  3. Click Add Account (or select an existing one) and click "Continue"
  4. In the next form, configure the JDBC connection properties:
    • Under JDBC JARs, add the JAR file we previously uploaded
    • Set JDBC Driver Class to cdata.jdbc.api.APIDriver
    • Set JDBC URL to a JDBC connection string for the Harvest JDBC Driver, for example:

      jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';RTK=XXXXXX;

      NOTE: RTK is a trial or full key. Contact our Support team for more information.

      Built-In Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Harvest 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.

      Start by setting the Profile connection property to the location of the Harvest Profile on disk (e.g. C:\profiles\Harvest.apip). Next, set the ProfileSettings connection property to the connection string for Harvest (see below).

      Harvest API Profile Settings

      To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

      Using Token Authentication

      To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

      Using OAuth Authentication

      First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

      After setting the following connection properties, you are ready to connect:

      • ProfileSettings: Set your AccountId in ProfileSettings.
      • AuthScheme: Set this to OAuth.
      • OAuthClientId: Set this to the client ID that you specified in your app settings.
      • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
      • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.
  5. After entering the connection properties, click "Validate" and "Apply"

Read Harvest Data

In the form that opens after validating and applying the connection, configure your query.

  • Set Schema name to "API"
  • Set Table name to a table for Harvest using the schema name, for example: "API"."Invoices" (use the drop-down to see the full list of available tables)
  • Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your Harvest data to another endpoint.

Piping Harvest Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

  1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
  2. Add an account to connect to Google Sheets
  3. Configure the Worksheet Writer snap to write your Harvest data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from Harvest and push it into a Google Spreadsheet.

More Information & Free Trial

Using the CData API Driver for JDBC you can create a pipeline in SnapLogic for integrating Harvest data with external services. For more information about connecting to Harvest, check at our CData API Driver for JDBC page. Download a free, 30 day trial of the CData API Driver for JDBC and get started today.