Skip to content
charles6611 edited this page Nov 26, 2020 · 8 revisions
  1. Go to developer.ebay.com and log in or create a new account
  2. Click on "My Account"
  3. Create a new Key Set

If using the Trading API, generate a new token (if one does not already exist) following the directions in the eBay Developer Program Getting Tokens tutorial.

ebay.yaml

To easily load eBay API credentials, we use ebay.yaml. The SDK searches for ebay.yaml first in the current directory, then the user's home directory and finally /etc; this file must be present in one of these locations to use the eBay APIs. Here are the required entries for each eBay API:

Value       Finding         Merchandising 	Shopping     Trading
-----------------------------------------------------------------
appid       Required        Required        Required     Required
certid             -               -        Required     Required
devid              -               -        Required     Required
token              -               -               -     Required
username           -               -               -     (*)
password           -               -               -     (*)
  • username/password is allowed instead of token for some internal eBay use

The required values should be entered into the skeleton ebay.yaml included in the distribution. Any unused values should be commented out. If a different endpoint hostname is desired, it should be specified in ebay.yaml and as a domain argument to the constructor.

Sandbox/Production Usage

Each eBay API has an endpoint for both production and sandbox usage. The production API is for live queries, but only allows a limited number of API calls per day (5000 by default). The sandbox API can be used to test the full buying and selling flow and has no quota, but requires test users to be created and only contains test listings. Please see the eBay Developer Documentation for more information on the sandbox.

Endpoints

Service 	        Sandbox Domain              Production Domain   HTTPS Required?
-----------------------------------------------------------------------------------
Finding API         svcs.sandbox.ebay.com       svcs.ebay.com       -
Merchandising API   svcs.sandbox.ebay.com       svcs.ebay.com       -
Shopping API        open.api.sandbox.ebay.com   open.api.ebay.com   -
Trading API         api.sandbox.ebay.com        api.ebay.com        Yes