Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Salesforce Marketing Cloud consists of three basic steps:

Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.

Provide the driver class. For example:

cdata.jdbc.sfmarketingcloud.SFMarketingCloudDriver

Provide the JDBC URL. For example:
```
jdbc:sfmarketingcloud:User=myUser;Password=myPassword;

or

jdbc:cdata:sfmarketingcloud:User=myUser;Password=myPassword;
```
The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:sfmarketingcloud:" or "jdbc:cdata:sfmarketingcloud:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Salesforce Marketing Cloud

For both REST and SOAP APIs, you have the option to refine data access using the following property:

Instance: The instance of the Salesforce Marketing Cloud API used. The default Instance is s7 of the Web Services API; however, you can use this property to specify a different instance.

REST API

To connect, set Schema to REST.

The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom OAuth application to obtain values for the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth App for more information.

SOAP API

To connect, set Schema to SOAP.

The Salesforce Marketing Cloud SOAP API can connect using OAuth, but also supports a legacy use of login credentials.

Authenticating to Salesforce Marketing Cloud

User Accounts (OAuth)

Set the AuthScheme to OAUTH. Also, in all OAuth flows, set AccountId to the specific MID of the target business unit. NOTE: This is not available for legacy packages. The following OAuth sections assume that you have set both these connection properties.

Desktop Apps

Follow the steps below to authenticate with the credentials for a custom OAuth application. See Creating a Custom OAuth App for information about custom OAuth applications. Get an OAuth Access Token

After setting the following, you are ready to connect:

OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.
CallbackURL: Set this to the Redirect URL in your application settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Web Apps

When connecting via a Web application, you need to register a custom OAuth application with Salesforce Marketing Cloud. See Creating a Custom OAuth App for information about custom OAuth applications. Then use the driver to get and manage the OAuth token values. Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

You can then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your application settings. If necessary, set the Permissions parameter to request custom permissions.
The stored procedure returns the URL to the OAuth endpoint.
Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- 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, as described in "Transfer OAuth Settings" below.
Then configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click Salesforce Marketing Cloud OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the rpgrestsp-getoauthauthorizationurl stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the driver. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the verifier code.
OAuthClientId: (custom applications only) Set this to the Client Id in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

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

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.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties:

OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Server-to-Server (OAuthClient)

When creating an application in Salesforce Marketing Cloud, you can select server-to-server authentication. In this case, the application's permissions are configured directly in the Salesforce Marketing Cloud UI. As such, there is no user context and hence no browser-based login or permission grants. For this scheme, you must create your own credentials.

Specify the following properties to enable server-to-server OAuth authentication for your application:

AuthScheme: Set this to OAuthClient.
InitiateOAuth: Set this to GETANDREFRESH.
OAuthClientId: Set this to the client Id.
OAuthClientSecret: Set this to the client secret.
Subdomain: Specify the Salesforce Marketing Cloud API subdomain.

User/Password Accounts (Basic)

The Salesforce Marketing Cloud SOAP API can connect using either your login credentials or OAuth authentication. Note that this authentication scheme is not available for REST API-based applications.

To connect to data using login credentials authentication, set the following:

AuthScheme: Set this to Basic.
User: The Salesforce Marketing Cloud user account.
Password: The password used to authenticate the user.
UseLegacyAuthentication: Set this to True.