Lua Requires Chilkat v11.0.0+

Get eBay Application Token

See more eBay Examples

This example shows how to request an eBay Application token. Lua

local chilkat = require("chilkat")

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

-- See the Ebay documentation about Access token types
-- Also see the Ebay documentation about client credentials grant flow

local http = chilkat.Http.new()

-- If using the sandbox, the target endpoint will be:
-- POST https://api.sandbox.ebay.com/identity/v1/oauth2/token

-- If using the production (live) system, the target endpoint will be:
-- POST https://api.ebay.com/identity/v1/oauth2/token

-- The eBay client_id and client_secret needs to be sent
-- in a Basic Authorization  request header, which has this format:
-- Authorization: Basic <B64_encoded_oauth_credentials>

-- Chilkat takes care of it.  You only need to set the Login = client_id,
-- and password = client_secret, and indicate you want "Basic" HTTP Authorization.
http.login = "EBAY_CLIENT_ID"
http.password = "EBAY_CLIENT_SECRET"
http.basic_auth = true

-- Let's do the following POST:

--   HTTP method:   POST
--   URL (Sandbox): https://api.sandbox.ebay.com/identity/v1/oauth2/token
--
--   HTTP headers:
--     Content-Type = application/x-www-form-urlencoded
--     Authorization = Basic <B64-encoded-oauth-credentials>
--
--   Request body (wrapped for readability):
--     grant_type=client_credentials&
--     redirect_uri=<RuName-value>&
--     scope=<SPACE separated list of scopes>
--

-- Create an HttpRequest object to hold the request params.
local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
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

req:add_param("scope", "https://api.ebay.com/oauth/api_scope")

local endPoint = "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
req.content_type = "application/x-www-form-urlencoded"

local resp = chilkat.HttpResponse.new()
local success = http:http_req(endPoint, req, resp)
if not success then
    print(http.last_error_text)
    return
end

-- The response is JSON..
local json = chilkat.JsonObject.new()
json:load(resp.body_str)
json.emit_compact = false

-- If the response status code is not 200, then it failed.
print("Response status code = " .. resp.status_code)
if resp.status_code ~= 200 then
    print(json:emit())
    print("Failed.")
    return
end

-- We successfully retrieved an eBay access token.
-- The actual access token string can be parsed from the JSON like this:
local accessToken = json:string_of("access_token")

-- This application token is only valid for 7200 seconds (2 hours).  We'll want to refresh
-- it before it expires.  (There is an online example for that..)
-- For now, let's save the JSON to a file for our application to use.

-- But before doing that, let's add to the JSON an expiration timestamp
-- so we know when to refresh the token.
local dtExpire = chilkat.DateTime.new()
dtExpire:set_from_current_system_time()
dtExpire:add_seconds(json:int_of("expires_in"))
json:append_string("expire_time", dtExpire:get_as_timestamp(false))

-- Persist the JSON to a file.
local fac = chilkat.FileAccess.new()
success = fac:write_entire_text_file("qa_data/tokens/ebay.json", json:emit(), "utf-8", false)
if not success then
    print(fac.last_error_text)
    print("Failed to save eBay Application token to file.")
    return
end

print(json:emit())
print("Success.")

-- The output of this example is:

--     {
--       "access_token": "v^1.1#i^1#p^1#I^3#r^0# ... Ajp1BQhJDgAA",
--       "token_type": "Application Access Token",
--       "expires_in": 7200,
--       "refresh_token": "N/A",
--       "expire_time": "2017-04-16T14:44:20Z"
--     }
--
--     Success.
--