Creating the Data Source Name

This section describes how to edit the DSN configuration and then authenticate and connect to eBay 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 APIs

Set the following to connect to eBay:

SiteID: Set this to the eBay site ID. By default this is "0" (the U.S. site).
UseSandbox: Set this to True to use a eBay sandbox account. By default, the connector connects to production environments.
RuName: Set this to the RuName (eBay Redirect URL name) that you will use to sign-in. Find this in your eBay Sign-in Settings.

Authenticating to eBay

The connector can authenticate to eBay using either the OAuth 2.0 authentication standard or Auth'n'Auth, the traditional authentication used by the eBay APIs.

User Accounts (OAuth)

Set AuthScheme to OAuth.

Desktop Applications

You need to create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications.

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) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
CallbackURL: Set to a URL containing the server name and port of the device running the connector. Any localhost address is usable. The default callback URL is: http://localhost:33333.

When you connect, the connector opens eBay's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector refreshes the access token automatically when it expires.

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.

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.
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.

Choose one of these options:
- Set the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set this to the App ID (Client ID) in your keyset.
  - OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL and RuName. Open the URL returned by the stored procedure in a browser.
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. If you're using the recommended value https://oauth.cdata.com/oauth/ as your "auth accepted URL", this value will be BASE64 encoded. You will need to decode this value before proceeding. 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.

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 noted verifier code (the value of the code parameter in the redirect URI).
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthSettingsLocation: Set this 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 App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
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. 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 location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then 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: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

User Accounts with Legacy Apps (Auth'n'Auth)

The connector can authenticate using eBay's legacy Auth'n'Auth protocol. Select this authentication scheme if you're using an older application that was built to use Auth'n'Auth.

Set AuthScheme to AuthNAuth.

You need to create a custom OAuth application. See Creating a Custom OAuth App for more information.

Access Token

An OAuthAccessToken is required when authenticating via Auth'n'Auth. Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
DevID: Set this to the Developer ID from your keyset.

Then call stored procedures to complete the token exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the RuName input to the eBay Redirect URL you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in, and authorize the web application. After authenticating, the browser redirects you to the redirect URI. There will be a parameter called sessionid appended to the redirect URI. Note the value of this parameter. If you are using the recommeded https://oauth.cdata.com/oauth/ as your "auth accepted URL", the value will be BASE64 encoded and will need to be decoded before proceeding.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the SessionId input parameter to either the value of the 'sessionid' in the query string of the authorization URL or the BASE64 decoded session ID from the callback URL.

Set the following connection properties to connect to data:

OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthAccessToken: Set this to the Auth'n'Auth token returned by GetOAuthAccessToken.
Note: Auth'n'Auth tokens expire after 18 months. You will need to generate a new token after the token expires.
DevID: Set this to the Developer ID from your keyset.

Power BI Connector for eBay