Linux DSN Configuration
This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL) and Fedora.
Minimum Linux Versions
Here are the minimum supported versions for Red Hat-based and Debian-based systems:
OS | Min. Version |
Ubuntu | 18.04 |
Debian | 10 |
RHEL | 8 |
Fedora | 28 |
SUSE | 15 |
Installing the Driver Dependencies
Run the following commands as root or with sudo to install the necessary dependencies:
- Debian/Ubuntu:
apt-get install libc6 libstdc++6 zlib1g libgcc1
- RHEL/Fedora:
yum install glibc libstdc++ zlib libgcc
Installing the Driver
You can use standard package management systems to install the driver.
On Debian-based systems, like Ubuntu, run the following command with root or sudo:
dpkg -i /path/to/driver/setup/AmazonMarketplaceODBCDriverforUnix.deb
On systems that support the RPM package format, run the following command with root or sudo:
rpm -ivh /path/to/driver/AmazonMarketplaceODBCDriverforUnix.rpm
Licensing the Driver
Run the following commands to license the driver. To activate a trial, omit the <key> input.
cd /opt/cdata/cdata-odbc-driver-for-amazonmarketplace/bin/
sudo ./install-license.sh <key>
Connecting through the Driver Manager
The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.
The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.
Creating the DSN
See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.
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:
- 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.
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.
- 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 driver 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.
- Then configure the driver 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:
- 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.
- Log in and grant permissions to the driver. 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 driver on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the driver and connect with the following properties set:
- OAuthSettingsLocation: Set this to a writable location.
- 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 driver 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.
Refreshing OAuth Values
The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.
To enable the automatic token exchange, you can give the driver write access to the system odbc.ini. Or, you can set the OAuthSettingsLocation connection property to an alternate file path, to which the driver would have read and write access.
OAuthSettingsLocation=/tmp/oauthsettings.txt
Installing Dependencies for OAuth Authentication
The OAuth authentication standard requires the authenticating user to interact with Amazon Marketplace, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.
To satisfy this dependency, install the corresponding package with your package manager:
Debian/Ubuntu Package | RHEL/Fedora Package | File |
xdg-utils | xdg-utils | xdg-open |
Set the Driver Encoding
The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.
Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-amazonmarketplace/lib/cdata.odbc.amazonmarketplace.ini':
[Driver]
AnsiCodePage = 932