Creating the Data Source Name
This section describes how to edit the DSN configuration and then authenticate and connect to eBay Analytics APIs.
DSN Configuration
You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the installation process creates a both a user DSN and a system DSN, as described in Installing the Connector.
Note: The connector stores connection information in the Windows registry. To ensure that the connector can write to the registry, either run Power BI as an administrator or use a User DSN for your connection instead of a System DSN.
User DSN
Complete the following steps to edit the DSN configuration:
- Select Start > Search, and enter ODBC Data Sources in the Search box.
- Choose the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit).
- Select the system data source and click Configure.
- Edit the information on the Connection tab and click OK.
System DSN
Configure the system DSN the same way as the user DSN, except you will need to switch to the System DSN tab before performing Step 3.
If you're using Power BI's On-Premises Data Gateway with Standard mode, you must use the system DSN.
You must also specify a valid location for OAuthSettingsLocation (a path where OAuth credentials are locally stored to avoid repeated OAuth prompts).
This is because the Standard mode runs on service mode and can only access permitted locations, such as C:\Windows\ServiceProfiles\PBIEgwService\AppData\Local\Microsoft\On-premises data gateway.
Connecting to eBay Analytics
You can establish a connection and authenticate to the eBay Analytics only via the OAuth 2 authentication method. The eBay Analytics API requires an access token created with the authorization code grant flow to authorize the requests.
Authenticating to eBay Analytics
eBay Analytics supports OAuth authentication only. AuthScheme must be set to OAuth in all OAuth flows.
Desktop Applications
You must create a custom OAuth application to authenticate via a desktop application. See Creating a Custom OAuth App for more information.Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- OAuthClientId: Set this to the App Id(client Id) assigned when you registered your application.
- OAuthClientSecret: Set this to the Cert Id (client secret) assigned when you registered your application.
- RuName: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.
- CallbackURL (Optional): Set this to a local Redirect URL (ex. http://localhost:33333) in case your OAuth application's auth accepted URL is set to https://oauth.cdata.com/oauth/ or to the actual one in case you are using another redirect URL.
- (Optional) UseSandbox: Set this to True if you are connecting to the Sandbox environment
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 connector 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 connector 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.
- Set 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.
- RuName: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.
- Log in and grant permissions to the connector. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- InitiateOAuth: Set to REFRESH.
- OAuthClientId: Set this to the App ID (Client ID) from your key set.
- OAuthClientSecret: Set this to the Cert ID (Client Secret) from your key set.
- RuName: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.
- OAuthVerifier: Set to the verifier code.
- OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified location.
Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
- InitiateOAuth: Set this to REFRESH.
- OAuthClientId: Set this to the client Id assigned when you registered your application.
- OAuthClientSecret: Set this to the client secret assigned when you registered your application.
- OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser.
- On a machine with an internet browser, install the connector and connect after setting the following properties:
- OAuthSettingsLocation: Set to a writable location.
- OAuthClientId: Set this to the App ID (Client ID) from your key set.
- OAuthClientSecret: Set this to the Cert ID (Client Secret) from your key set.
- RuName: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.
- (Optional) CallbackURL: Set this to a local Redirect URL (for example, http://localhost:33333) in case your OAuth application's "auth accepted URL" is set to https://oauth.cdata.com/oauth/ or to the actual one in case you are using another redirect URL.
- Test the connection to authenticate. The resulting authentication values are written, encrypted, to the location 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 to REFRESH.
- OAuthSettingsLocation: Set 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.