Harvest Profile for API Driver
The Lyftron API Profile for Harvest allows you to query data from Harvest. The Harvest profile is a single file (i.e. harvest.apip) which is meant to be used with the Lyftron API Driver. The profile contains the table definitions and other Harvest specific metadata that the Lyftron API Driver uses to connect to Harvest.
To use the Harvest Profile set the Profile property of Lyftron API Driver to the path of the Harvest profile, as well as the other connection properties specified in the documentation below. Once the Lyftron API Driver has been configured, you can issue SQL queries to access data from any of the Harvest Tables.
Connecting to Harvest
To authenticate to Harvest, you can use either Basic 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 Basic Authentication
To use Basic Authentication, specify your Api-Key in the ProfileSettings connection property. Set Api-Key to your Harvest Personal Access Token.
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 in the ProfileSettings connection property, you are ready to connect:
- 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.