Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

1. Select Start > Search, and enter ODBC Data Sources in the Search box.
2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
3. Click the System DSN tab.
4. Select the system data source and click Configure.
5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Ensuring Registry Access

The driver stores connection information in the Windows registry. To ensure that the driver can write to the registry, perform either of the following actions:

1. Run the calling application as an administrator.
2. Connect via a User DSN instead of a System DSN.

Authenticating to QuickBooks Online

QuickBooks Online supports connecting and authenticating via a desktop application, a web browser, or a headless machine. The CData ODBC Driver for QuickBooks Online includes embedded OAuth credentials that simplify connection from the desktop or a headless machine and provide limited functionality. However, to experience fuller functionality via desktop or headless machine connections OR to connect via the web, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

The following subsections describe how to authenticate to QuickBooks Online from all OAuth workflows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in QuickBooks Online, see Connection.

Desktop Applications

The properties required for connection depend on whether you want to connect via the embedded OAuth credentials (limited use) or connect via a custom OAuth Application (full functionality):

Before you connect, set the required properties:

• InitiateOAuth (all users): GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId (custom OAuth only): The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
• OAuthClientSecret (custom OAuth only): The client secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
• CallbackURL (custom OAuth only): The redirect URI defined when you registered your custom OAuth application (see Creating a Custom OAuth Application).

When you connect, the driver opens QuickBooks Online's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the driver refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the driver automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the driver to save the OAuth values, which persist across connections.

2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
   • OAuthClientSecret: The Client Secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value.
• Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

   If you are using the embedded OAuth application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.

   If you are using a custom OAuth application, set these properties:

   • InitiateOAuth: OFF.
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).

2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered (see Creating a Custom OAuth Application).

   Copy this URL and paste it into a new browser tab.

3. Log in and grant permissions to the driver. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, to obtain the OAuthAccessToken, set these connection properties:

   • InitiateOAuth (all users): REFRESH.
   • OAuthVerifier (all users): The noted verifier code (the value of the code parameter in the redirect URI).
   • OAuthSettingsLocation (all users): persist the encrypted OAuth authentication values to the specified file.
   • OAuthClientId (custom OAuth only): The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
   • OAuthClientSecret (custom OAuth only): The client secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).

   • Test the connection to generate the OAuth settings file.

   • You are ready connect after you re-set these properties:

     • InitiateOAuth (all users): REFRESH.
     • OAuthSettingsLocation (all users): The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the driver.
     • OAuthClientId (custom OAuth only):: The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
     • OAuthClientSecret (custom OAuth only):: The client secret aassigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

• InitiateOAuth (all users): REFRESH.
• OAuthSettingsLocation (all users): The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.
• OAuthClientId (custom OAuth only): The client Id assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).
• OAuthClientSecret (custom OAuth only): The client secret assigned when you registered your custom OAuth application (see Creating a Custom OAuth Application).