Lyftron Groove Provider
The Lyftron API Profile for Groove allows you to query data from Groove. The Groove profile is a single file (i.e. groove.apip) which is meant to be used with the Lyftron API Driver. The profile contains the table definitions and other Groove specific metadata that the Lyftron API Driver uses to connect to Groove.
To use the Groove Profile set the Profile property of Lyftron API Driver to the path of the Groove 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 Groove Tables.
Connecting to Groove
To authenticate to Groove, you can use either Access Token authentication or the OAuth standard. Use Access Token to connect to your own data. Use OAuth to allow other users to connect to their data.
Using Access Token
Groove requires a user to be authenticated with an access token. Set it as the Api-Key property in the ProfileSettings connection property. You'll need to be an account administrator to access your account's private access token. If you are, just click the "API" section under account settings to grab your key and get started.
Using OAuth Authentication
First, you need to register an OAuth app with Groove. To create your Groove OAuth app, contact Groove for assistance. You will need to provide Groove with the Redirect Url that will be associated with your app.
After setting the following in the ProfileSettings connection property, you are ready to connect:
- OAuthClientId: Set this to the client_id that Groove emailed to you for your app.
- OAuthClientSecret: Set this to the client_secret that Groove emailed to you for your app.
- CallbackURL: Set this to the Redirect URI that you specified when you applied for an app with Groove.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.