eBay

Version 24.2.9064


eBay


You can use the eBay connector from the CData Sync application to capture data from eBay and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Prerequisites

To use the authentication schemes in the Authenticate to eBay section below, you must create a custom OAuth application that will enable you to access your data and other users to access their data.

Before you create the custom application, you must join the eBay Developers Program. After you join this program, you can obtain the values for the following properties that you will need for authentication from the Application Keysets page on the eBay Developers Program website.

  • OAuth Client Id and OAuth Client Secret (for both the OAuth and AuthNAuth schemes)

  • Dev ID (AuthNAuth scheme only)

The following sections explain how to create a custom OAuth app based on the authentication scheme that you want to use in Sync.

OAuth

To use the OAuth scheme in Sync, you must create a custom OAuth application that enables you to access your data and other users to access their data, as follows:

  1. On your eBay Developer Account Dashboard, open the User Access Tokens page.

  2. Select the environment for your application:

    • Select Production if you want to search for real items or listing real items to the live eBay site.

    • Select Sandbox if you want to create test listings in the sandbox.

  3. In the Get a Token from eBay via Your Application section (under Your eBay Sign-in Settings), add a new RuName (the eBay Redirect URL) by clicking Add eBay Redirect URL or expand the tab for the RuName that you want to use for authentication.

  4. Select the OAuth Enabled checkbox for your RuName. (If the checkbox is not enabled, only the Auth’n’Auth authentication method is supported.)

  5. Set Your auth accepted URL to https://oauth.cdata.com/oauth/ since eBay requires a secure redirect URL (HTTPS) and does not accept a localhost URL.

  6. Click Save to save your changes.

  7. Select OAuth. Then, click Test Sign-In to verify that you can sign in with your RuName.

Auth’n’Auth

To use the AuthNAuth scheme in Sync, you must create a custom OAuth application that will enable you to access your data, as follows:

  1. On your eBay Developer Account Dashboard, open the User Access Tokens page.

  2. Select the environment for your application:

    • Select Production if you want to search for real items or listing real items to the live eBay site.

    • Select Sandbox if you want to create test listings in the sandbox.

  3. Under Get a User Token Here, select the authentication method that you want to use when you generate a token. OAuth tokens are valid for all eBay APIs (RESTful APIs and traditional APIs), while Auth’n’Auth tokens are valid only for traditional APIs.

  4. Click Sign in to Sandbox or Sign in to Production (dependent on the environment you chose in step 2) and log in with the appropriate credentials for that environment.

To enable OAuth authentication, select the OAuth Enabled checkbox (under Your eBay Sign-in Settings) for the RuName (the eBay Redirect URL name) that you will use to sign in. If the checkbox is not enabled, only the Auth’n’Auth authentication method is supported.

Add the eBay Connector

To enable Sync to use data from eBay, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the eBay row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the eBay connector. For more information about installing new connectors, see Connections.

Authenticate to eBay

After you add the connector, you need to set the required properties.

  • Connection Name - Enter a connection name of your choice.

  • Ru Name - Enter the redirect URL name that is used for validation. This property is required only when you use the provider to allow other users to access their own data.

CData Sync supports authenticating to eBay in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

OAuth

To connect with OAuth custom credentials, specify the following properties:

  • Auth Scheme – Select OAuth.

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

AuthNAuth

To connect with eBay’s legacy Auth’n’Auth protocol, specify the following properties:

  • Auth Scheme – Select AuthNAuth.

  • Dev ID - Enter your developer Id, as registered with the eBay Developers Program.

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Access Token - Enter the access token that you use for connecting via OAuth.

Complete Your Connection

To complete your connection:

  1. Specify the following properties:

    • Site ID - Enter the Id of the eBay site to which you want to send the request. The default Id is 0

    • Use Sandbox - Select True if you want to connect to a sandbox account. The default value is False.

  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  3. If you authenticate with OAuth, click Connect to eBay to connect to your eBay account.

  4. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and eBay, see eBay Connector for CData Sync.