Lua Requires Chilkat v11.0.0+

Get Ebay OAuth2 Token using Client Credentials Grant Flow

See more eBay Examples

Demonstrates how to get a Ebay OAuth2 access token using the client credentials grant flow.

There are two ways of "minting" an OAuth2 access token.

1. The authorization code grant flow (https://developer.ebay.com/api-docs/static/oauth-authorization-code-grant.html) This is where your app will be accessing another person's eBay account. It's an interactive process and requires the account owner's permission to get the access token the 1st time. After that, it can be refreshed indefinitely without user interaction.
2. The client credentials grant flow (this example) (https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html) This is where you access your own eBay account. It's non-interactive and you can do it in automated services where user-interaction is not possible.

Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local http = chilkat.Http.new()

-- Implements the following CURL command:

-- curl -X POST 'https://api.sandbox.ebay.com/identity/v1/oauth2/token' \
--   -H 'Content-Type: application/x-www-form-urlencoded' \
--   -H 'Authorization: Basic UkVTVFRlc3...wZi1hOGZhLTI4MmY=' \
--   -d 'grant_type=client_credentials&scope=https%3A%2F%2Fapi.ebay.com%2Foauth%2Fapi_scope'

-- Use the following online tool to generate HTTP code from a CURL command
-- Convert a cURL Command to HTTP Source Code

local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
req.path = "/identity/v1/oauth2/token"
req.content_type = "application/x-www-form-urlencoded"
req:add_param("grant_type", "client_credentials")

-- The scope query param indicates the access to be provided by the token.
-- Multiple scopes can be specified by separating each with a SPACE char.
-- See the Ebay OAuth scopes documentation

local scope = "https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/buy.order.readonly https://api.ebay.com/oauth/api_scope/buy.guest.order 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 https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly https://api.ebay.com/oauth/api_scope/buy.shopping.cart https://api.ebay.com/oauth/api_scope/buy.offer.auction"

req:add_param("scope", scope)

-- Setting these properties causes the Authorization: Basic UkVTVFRlc3...wZi1hOGZhLTI4MmY=
-- header to be added.
http.login = "EBAY_CLIENT_ID"
http.password = "EBAY_CLIENT_SECRET"
http.basic_auth = true

local resp = chilkat.HttpResponse.new()
local success = http:http_req("https://api.sandbox.ebay.com/identity/v1/oauth2/token", req, resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
end

-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)

-- {
--   "access_token": "v^1.1#i^1#p^1#r^0#I^3#f^0#t^H4s ... wu67e3xAhskz4DAAA",
--   "expires_in": 7200,
--   "token_type": "Application Access Token"
-- }

-- Sample code for parsing the JSON response...
-- Use the following online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON

local access_token = jResp:string_of("access_token")
local expires_in = jResp:int_of("expires_in")
local token_type = jResp:string_of("token_type")