Tableau Connector for Amazon Marketplace

Build 25.0.9434

Configuring a Connection

After Installing the Connector you can connect and create a Data Source for data in Amazon Marketplace.

Setting Up a Data Source

Complete the following steps to connect to the data:

  1. Under Connect | To a Server, click More....
  2. Select the data source called Amazon Marketplace by CData.
  3. Enter the information required for the connection.
  4. Click Sign In.
  5. If necessary, select a Database and Schema to discover what tables and views are available.

Using the Connection Builder

The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.

There are two ways to access the connection builder:

  • On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Amazon Marketplace folder.
  • You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.

In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.

Connecting to Amazon Marketplace

The following properties are required:

  • Schema: Set this to SellerCentral.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.

Authenticate to Amazon Marketplace

OAuth

Amazon Marketplace uses the OAuth authentication standard.

To authenticate using OAuth, you must either use the embedded application or create a new custom OAuth app. The embedded application supports desktop applications and headless machines. Web applications require that you create a custom OAuth application.

You can use a custom OAuth application to authenticate with a service account or a user account. See Creating a Custom OAuth App for more information.

Downloading Embedded Credentials

Because Amazon Marketplace requires that embedded credentials rotate every six months, CData credentials are hosted on oa.cdata.com. If you do not specify custom credentials, the embedded credentials are downloaded from our web service and saved in the location specified in OAuthClientLocation by default. NOTE: Make sure your firewall does not block oa.cdata.com.

Desktop Apps

You can use the embedded application or create a custom OAuth application. The key difference is that you must set additional connection properties if you use a custom application.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • AppId: Set this to the application Id for the Selling Partner application you created.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.

Headless Machines

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

  1. Choose one of these two options:

    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the connector on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

  2. Then configure the connector to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

Follow these steps to authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Choose one of these options:
    • 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 the following properties:
      • InitiateOAuth: Set this to OFF.
      • OAuthClientId (custom applications only): Set this to the Client Id in your application settings.
      • OAuthClientSecret (custom applications only): Set this to the Client Secret in your application settings.

        Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

  2. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code as the value for 'spapi_oauth_code'. Save the value of the verifier code. You must set this in the OAuthVerifier connection property later.

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

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

  • OAuthClientId (custom applications only): Set this to the consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.
  • InitiateOAuth: Set this to REFRESH.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthClientId (custom applications only): Set this to the consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AppId: Application Id for Selling Partner application you created.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

Option 2: Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable location.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.

Test the connection to authenticate. The resulting authentication values are encrypted and written to a file located in the path specified by OAuthSettingsLocation. After you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId (custom applications only): Set this to the consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AppId: Application Id for Selling Partner application you created.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

Next Step

See Using the Connector to create data visualizations.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434