# Glossary
# App ID (see Client ID)
Unique string that identifies your application. See Client ID.
# Application keys
See eBay's Getting Your Keys.
# Application token
An application token is a string passed along with an eBay API call that represents permission to use the eBay API. It requires fewer permissions than the user token and is used for lower-impact purposes, such as doing searches or obtaining information about an item listing. See Using OAuth and Application Keys with the eBay API: eBay OAuth explained
# Cert ID, also known as Client Secret
Also know as the client cecret
# Client ID, also known as App ID
A unique string assigned to you by eBay to identify your application. Do not include it in any codes or reveal it to anyone else. ee eBay's Getting Your Keys.
# Client Secret
See Cert ID
# Dev ID
A unique string assigned to you by eBay to identify your company's account.
# Endpoint
The web address called to obtain information from eBay.
For example, https://api.sandbox.ebay.com/identity/v1/oauth2/token
.
# HTTP request
An HTTP request consists of:
- A request method such as
GET
orPOST
- A request URI or line, such as
https://api.sandbox.ebay.com/identity/v1/oauth2/token
. This is informally know as an endpoint. - Optional headers, such as
Content-Type: application/x-www-form-urlencoded
- An optional message body. For more, see The client credentials grant flow
# OAuth
# OAuth Scopes, aka scopes
See scopes.
# Production, production API
The actual running version of eBay itself. An API call it might look
lke https://api.ebay.com/identity/v1/oauth2/token
, for example.
To experiment without running afoul of eBay, you can use the Sandbox,
with endpoints like
https://api.sandbox.ebay.com/identity/v1/oauth2/token
.
# REST
A way to make API calls with well-chosen URLs. For more see Representational state transfer on Wikipedia.
eBay's RESTful APis all require authentication first.
# RuName (aka eBay Redirect URL name)
When obtaining consent from your user to issue a user token, eBay redirects the user to a specified page. Instead of passing the actual URL, you pass an alias for it called the RuName or Redirect URL name. See Getting your redirect_uri value
# Sandbox, sandbox API
Simulated version of eBay that lets you make API calls
without affecting live auctions. An example
endpoint would be https://api.sandbox.ebay.com/identity/v1/oauth2/token
.
Calls to the production site use endpoints like
https://api.ebay.com/identity/v1/oauth2/token
.
# Scopes
Scopes limit permission to the access specified by an application token or user token.
# User token
An user token is a string passed along with an eBay API call that represents elevated permission to use the eBay API. It requires more permissions than the application token and can make changes to the account. Actions it might perform include creating and updating lists, making purchases on behalf of the user, and place auction bids. Obtaining a user token is contingent upon sending the user to a page that explains where your application comes from, what permissions are going to be granted, and how your privacy policy works. See Using OAuth and Application Keys with the eBay API: eBay OAuth explained