API Data Provider - Online Help

Connecting to Front

To authenticate to Front, you can use either Token authentication or the OAuth standard. Use Token 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, specify your APIKey in the ProfileSettings connection property. You can generate an api key under 'Settings' > 'Plugins & API' > 'API'.

Example connection string

Profile=C:\profiles\Front.apip;ProfileSettings='APIKey=my_api_key';

Using OAuth Authentication

To authenticate via OAuth, you will first need to register your OAuth application with Front. You can register an app and obtain your OAuth credentials by contacting Front at [email protected].

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

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the client ID that you received upon app registration
  • OAuthClientSecret: Set this to the client secret that you received upon app registration.
  • CallbackURL: Set this to the Redirect URI that you specified in your app.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.

Example connection string

Profile=C:\profiles\Front.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your personal API Token.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: NONE, OAUTH
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0