eBay JavaScript SDK
Read Me

The eBay JavaScript SDK makes it easier for you, as a JavaScript developer, to access the eBay Web Services platform. You will program to JavaScript interfaces instead of dealing with API response payloads and low-level interactions with the API platform. Additionally, common issues like cross-domain security are handled by the SDK.

For more information, visit the JavaScript Developer Center.

Version 2.2

Version 2.2 of the eBay JavaScript SDK is based on eBay Shopping Web Services release 549. See the eBay Shopping Web Services Release Notes for information about the changes and updates associated with a specific release of the Shopping API.

Compatibility

The eBay JavaScript SDK requires a JavaScript-enabled browser. Version 2.2 of the eBay JavaScript SDK has been tested on and is supported for the following browsers:

• Microsoft Internet Explorer version 6.0 and higher
• Mozilla Firefox 2.x

What's New in Version 2.2?

This version of the JavaScript SDK contains five new calls, two new samples, and a timeout retry method that will automatically re-submit a failed call.

Five New Calls

The following calls from the eBay Shopping API have been added to the JavaScript SDK:

• FindPopularItems
• FindPopularSearches
• FindReviewsAndGuides
• GetCategoryInfo
• GeteBayTime

Two New Samples

The following samples (applications that use Shopping API calls) have been added to the JavaScript SDK:

• FindPopularItems
• ProductReviewsAndGuides

Timeout Retry

The Timeout Retry capability has been added as part of the JavaScript SDK 2.2. To use this feature, you just need to pass in a RetryConfig object when you are creating the Shopping object. RetryConfig has the following configurable parameters:

• timeoutPeriod: Call timeout interval in milliseconds, default is 2000.
• retryInterval: Interval between retries in milliseconds, default is 250.
• retryCount: Number of times to retry a failed call, default is 3.
• enable: If timeout retry is enabled, default is true.

The following is an example of these parameters:

var shoppingConfig = {appId:'YourAppID'};
var retryConfig = {enable: true, timeoutPeriod: 1000, retryInterval: 200, retryCount: 3};
var service = new com.ebay.shoppingservice.Shopping(shoppingConfig, retryConfig);

Migration from Previous Versions of the JavaScript SDK

The eBay JavaScript SDK 2.2 is backward compatible with the JavaScript Toolkit 2.0. It is not compatible with the JavaScript Toolkit 1.0.

We recommend that you download the latest version of the JavaScript SDK and use the samples as an example of how to use each Shopping API call. If you are having trouble migrating custom code that you created with the JavaScript Toolkit 1.0, please contact eBay's Developer Technical Support.

SDK Download Contents

The eBay JavaScript SDK Download contains everything you need to create your own eBay JavaScript widgets. The download (.zip) file includes the following items:

• SDK source file—the SDK source file, JSSDK#.#.zip (where #.# is the SDK version), contains all the code needed to interact with the eBay Shopping API, store data, and handle error conditions.
• Documentation—the SDK includes the eBay JavaScript SDK User Guide and the API documentation for the classes, fields, methods, and constructors in the SDK.
• Samples—the SDK includes sample code for the following calls: FindItemsAdvanced, GetUser Profile, and Find Products, FindPopularItems, and ProductReviewsAndGuides.
• Common Development and Distribution License—the SDK is licensed under the terms of the Common Development and Distribution License ("CDDL"), which is included in the SDK.

Getting Started

Once you have downloaded and unzipped the contents of the SDK, follow these steps to get started:

1. If you haven't already, join the eBay Developers Program and get your Development Keys from your My Account page.

   You need an AppID to use the eBay Shopping API. Joining is easy and it's FREE!

2. Review the eBay JavaScript SDK User Guide to learn more about what's in the SDK and how to use it.
   
   
3. Check out the samples for the FindItemsAdvanced, GetUserProfile, FindProducts, FindPopularItems, and ProductReviewsAndGuides calls.
   
   
4. Start creating widgets and other JavaScript components of your own, using the eBay JavaScript SDK!
   
   

Documentation and Support

Visit the eBay JavaScript Developer Center for more information and links for current documentation and support.

Known Issues

For a current list of known issues, see System Announcements and the Knowledge Base.

License Information

The eBay JavaScript SDK is licensed under the terms of the Common Development and Distribution License ("CDDL"). A copy of the CDDL, COMMON DEVELOPMENT AND DISTRIBUTION LICENSE.doc, is included within the SDK. Please review the license before using the eBay JavaScript SDK.

See the following sites for more information:

Open Source Initiative OSI - Common Development and Distribution License (CDDL)
(http://www.sun.com/cddl/)
Common Development and Distribution License (CDDL) Information
(http://www.opensource.org/licenses/cddl1.php)

User-Contributed Notes

© 2007-2008 eBay Inc. All rights reserved.