> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# eBay

export const CommonAuthSchemeOauthCustom = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with OAuth custom credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>OAuth</strong>.</li>
        <li><strong>OAuth Client Id:</strong> Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.</li>
        <li><strong>OAuth Client Secret:</strong> Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.</li>
      </ul>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "eBay";
export const pageTitle = "eBay";
export const advancedurl = "BE";
export const oauthschemes = "OAuth";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Prerequisites

To use the authentication schemes in the [Authenticate to eBay](#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 <a href="https://developer.ebay.com/" target="_blank" rel="noopener noreferrer">eBay Developers Program</a>. 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 <a href="https://developer.ebay.com/" target="_blank" rel="noopener noreferrer">eBay Developers Program</a> 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 {siteNameShort}.

## Creating a Custom OAuth Application

To use the **OAuth** scheme in {siteNameShort}, 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/](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.

### Using Auth'n'Auth

To use the **AuthNAuth** scheme in {siteNameShort}, 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

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to eBay

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

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

{siteName} supports authenticating to {pageTitle} in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**OAuth**](#oauth)
* [**AuthNAuth**](#authnauth) (default)

### OAuth

<CommonAuthSchemeOauthCustom siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### 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 whether you want to enable the sandbox. By default, the **Enable** checkbox is not selected.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. {oauthschemes ? `If you authenticate with ${oauthschemes}, click` : "Click"} **Connect to {datasource}** to connect to your {pageTitle} account.
4. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />