API Data Provider - Online Help

Connecting to Drip

To authenticate to Drip, 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 within the ProfileSettings connection property. The APIKey should be set to your Drip personal API Token.

Example connection string

Profile=C:\profiles\Drip.apip;ProfileSettings='APIKey=my_api_token';

Using OAuth Authentication

First, register an OAuth2 application with Drip. Drip will then supply you with a client id and client secret. Please be aware that you must also enter a valid callback url before you will be able to activate your application.

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

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the client id that you got in your app settings.
  • OAuthClientSecret: Set this to the client secret that you got in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

Example connection string

Profile=C:\profiles\Drip.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=my_clientId;OAuthClientSecret=my_clientSecret;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 API Key.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT
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 24.0.9060.0