Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

Connect to Harvest Data and Transfer Data in Talend



Integrate Harvest data with standard components and data source configuration wizards in Talend Open Studio.

This article shows how you can easily integrate the CData JDBC driver for Harvest into your workflow in Talend. This article uses the CData JDBC Driver for Harvest to transfer Harvest data in a job flow in Talend.

Connect to Harvest in Talend as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Harvest:

  1. Add a new database connection to Harvest data: To add a new connection, expand the Metadata node, right-click the Db Connections node, and then click Create Connection.
  2. In the resulting wizard, enter a name for the connection.
  3. On the next page, select Generic JDBC from the DB Type menu and enter the JDBC URL.

    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.

    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.

    A typical JDBC URL is below:

    jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
  4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
  5. Right-click the connection and then click Retrieve Schema.
  6. Click Next with the default options to select the tables you want to import.
  7. Finish the wizard with the default options.

Output the Invoices Table to a Flat File

You can follow the procedure below to transfer the Invoices table to a flat file output component:

  1. In the Table Schemas node, drag the tables to the workspace.
  2. In the dialog that is displayed, select the tJDBCInput component.
  3. Next, drag a tFileOutputDelimited component from the Business Intelligence tab of the Palette into the workspace.
  4. Right-click the Invoices tJDBCInput component and drag a vector to the output file.

Run the project to transfer the data.