eBay Ecommerce Reader
Note
This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.
eBay is a global online marketplace that connects vendors with buyers of products and services. eBay allows users to buy, sell, interact other users, and even provide feedback. Striim's eBay Reader converts these application entities into relational tables and facilitates the real-time, straightforward migration of data from the application to any relational database or data warehouse analytics solution, resulting in improved reporting and profound insights.
Feature summary
Feature | Supported? | Notes | |
---|---|---|---|
Objects | Standard objects | ✓ | |
Custom objects | ✓ | ||
Authentication | Basic authentication | Username and password | |
OAuth authentication | ✓ | Manual configuration based | |
Custom authentication methods | Not all methods may be supported | ||
Operations | Automated mode | ✓ | |
Initial load | ✓ | ||
Pull-based incremental load | ✓ | ||
Push-based incremental load | |||
Automated pipeline | |||
Governance | Connection profile | ||
Sherlock AI | |||
Sentinel AI | |||
Schema handling | Initial schema creation | ✓ | Works with supported targets |
Schema evolution | |||
Setup | Wizard template | ||
Flow Designer | ✓ | ||
Striim TQL | ✓ | ||
Runtime | Resilience/recovery | ✓ | |
Parallel execution | |||
Metrics | ✓ | Standard metrics |
Supported authentication method
The eBay Ecommerce Reader supports OAuth authentication. Creating a connection requires creating an application in the eBay Developer Program Dashboard, obtaining the OAuth credentials from eBay, requesting and obtaining an authorization code, exchanging the authorization code for an access token and refresh token, and setting the connection properties in Striim.
To create a connection using OAuth authentication:
Go to the eBay Developer Program Dashboard.
Choose Application Keys under the API Keys section.
Select Create a new application.
Enter the details for your application.
Note the Client ID (also called App ID) and Client Secret (App Secret) issued to you.
In the eBay Developer Dashboard, specify the redirect URI (where eBay will send users after they authorize access).
Redirect your user to eBay's OAuth URL for authentication. The user will authorize the application to access their account, and eBay will redirect to your specified redirect URI with an authorization code. The URL is in the following format:
https://auth.ebay.com/oauth2/authorize?client_id=<Your-Client-ID>&response_type=code &redirect_uri=<Your-Redirect-URI>&scope=https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
Once the user authorizes the app, they’ll be redirected to your specified redirect URI with an authorization code.
Exchange the authorization code for an access token and refresh token by making a POST request to eBay's token endpoint. The token endpoint URL is:
https://api.ebay.com/identity/v1/oauth2/token
In the request body, you need to send the following:
client_id
: Your client ID.client_secret
: Your client secret.redirect_uri
: The same redirect URI you used before.code
: The authorization code you received.grant_type
:authorization_code
Example (using
curl
):curl -X POST https://api.ebay.com/identity/v1/oauth2/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -u "Client-ID:Client-Secret" \ -d "grant_type=authorization_code&code=AUTHORIZATION_CODE &redirect_uri=YOUR_REDIRECT_URI"
The response will include:
access_token
: The access token (valid for a limited time).refresh_token
: The refresh token (can be used to get new access tokens when expired).expires_in
: Time in seconds before the access token expires.
Supported objects
The following are the supported objects for reading from eBay:
Bidders
Categories
CategoryFeatures
CategorySubtree
CategorySuggestions
CategoryTree
CompatibilityProperties
CompatibilityPropertyValues
Countries
Currencies
DefaultCategoryTreeId
FulfillmentPolicies
HighestBidder
ItemAspectsForCategory
ItemCompatibilityList
ItemListing
ItemShipping
ItemSpecifics
ItemTransactions
ItemVariations
MostWatchedItems
OrderPayments
OrderShipping
Orders
PaymentPolicies
ReturnPolicies
ShippingCarriers
ShippingCategories
ShippingLocations
ShippingServices
Sites
SuggestedCategories
Tasks
TopSellingProducts
TransactionLinkedItems
TransactionPayments
TransactionRefunds
TransactionShipping
Transactions
eBay Ecommerce Reader properties
Property | Type | Default value | Notes |
---|---|---|---|
Client ID | String | The client ID assigned when you register your application with an OAuth authorization server. | |
Client secret | Password | The client secret assigned when you register your application with an OAuth authorization server. | |
Access token | Password | The access token for connecting using OAuth. The OAuth access token is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests. | |
Refresh token | Password | The OAuth refresh token for the corresponding OAuth access token. | |
Connection pool size | Integer | 20 | Specifies the maximum number of active connections. |
Exclude tables | String | A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. | |
Incremental load marker | String | The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria:
| |
Migrate schema | Boolean | False | Only available in Initial Load or Automated mode. Set to |
Mode | Select list:
| Automated | Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load. |
Polling interval | Integer | 5m | Specifies an interval as an integer followed by a unit. Supported units are days ( |
Start Position | String | %=-1 | Value of the incremental load marker that defines the initial reading position. |
Tables | String | A semicolon-delimited (;) list of objects to read from the source. Supports the | |
Thread pool count | Integer | 10 | The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice. |