Using a Connection String

For some applications, you might need to use a connection string to connect to your data source. For more information about how to use a connection string in an ODBC application, refer to the documentation for the application that you are using.

The connection strings in the following sections are examples showing the minimum set of connection attributes that you must specify to successfully connect to the data source. Depending on the configuration of the data source and the type of connection you are working with, you might need to specify additional connection attributes. For detailed information about all the attributes that you can use in the connection string, see Connector Configuration Options.

Note:

If the server does not support HTTPS connections or SSL verification, then you must disable those features by setting additional properties in your connection string. For more information, see Configuring SSL Verification.

DSN Connection String Example

The following is an example of a connection string for a connection that uses a DSN:

DSN=[DataSourceName]

[DataSourceName] is the DSN that you are using for the connection.

You can set additional configuration options by appending key-value pairs to the connection string. Configuration options that are passed in using a connection string take precedence over configuration options that are set in the DSN.

DSN-less Connection String Example

Some applications provide support for connecting to a data source using a connector without a DSN. To connect to a data source without using a DSN, use a connection string instead.

The placeholders in the examples are defined as follows, in alphabetical order:

  • [Endpoint] is the endpoint of the QuickBooks Online server that you are connecting to.
  • [RealmId] is the company ID associated with your QuickBooks account.
  • [YourAccessToken] is your access token for authenticating to QuickBooks.
  • [YourPath] is the full path of the .pem file containing trusted CA certificates for verifying the server during SSL authentication.

Connecting to QuickBooks Using an Access Token

The following is the format of a DSN-less connection string for connecting to QuickBooks using an access token:

Driver=Simba QuickBooks ODBC Driver;Host=[Endpoint];Auth_Type=OAuth 2.0;Auth_AccessToken=[YourAccessToken];Auth_Realm=[RealmId];

For example:

Driver=Simba QuickBooks ODBC Driver;
Host=sandbox-quickbooks.api.intuit.com;Auth_Type=OAuth 2.0;Auth_AccessToken=1jt9Pcyq8pr3lvu143pfl4r86;Auth_Realm=12384820303;

Access tokens are valid for a limited amount of time only. If you provide a refresh token, the connector can refresh the access token when it expires.

For example:

Driver=Simba QuickBooks ODBC Driver;
Host=sandbox-quickbooks.api.intuit.com;Auth_Type=OAuth 2.0;Auth_Realm=12384820303;Auth_RefreshToken=g9lQdaJqkRBaVj2jOnzQqT1u7;

Connecting to QuickBooks Using Windows Trust Store

The following is the format of a DSN-less connection string for connecting to the QuickBooks server that requires SSL and uses the Windows trust store:

Driver=Simba QuickBooks ODBC Driver;Host=[Endpoint];Auth_Type=Access Token;Auth_AccessToken=[YourAccessToken];SystemTrustStore=1;

For example:

Driver=Simba QuickBooks ODBC Driver;Host=sandbox-quickbooks.api.intuit.com;Auth_Type=OAuth_2.0;Auth_AccessToken=
kN9PcyQ9prK4LvL4R+lVE=;SystemTrustStore=1;

The following is the format of a DSN-less connection string for connecting to the QuickBooks server that requires SSL and uses the path provided in the TrustCertsPath property:

Driver=Simba QuickBooks ODBC Driver;Host=[Endpoint];Auth_Type=Access Token;Auth_AccessToken=[YourAccessToken];SystemTrustStore=0;TrustCertsPath=[YourPath];

For example:

Driver=Simba QuickBooks ODBC Driver;Host=sandbox-quickbooks.api.intuit.com;Auth_AccessToken=
kN9PcyQ9prK4LvL4R+lVE=;SystemTrustStore=0;TrustCertsPath=C:\Users\JSmith\Desktop\Cert\QuickBooks.pem;