(Lianja) Get eBay Application Token

This example shows how to request an eBay Application token.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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

loHttp = createobject("CkHttp")

// 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.
loHttp.Login = "EBAY_CLIENT_ID"
loHttp.Password = "EBAY_CLIENT_SECRET"
loHttp.BasicAuth = .T.

// 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.
loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.AddParam("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

loReq.AddParam("scope","https://api.ebay.com/oauth/api_scope")

// (The PostUrlEncoded method automatically sets the Content-Type header equal to "application/x-www-form-urlencoded")
lcEndPoint = "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
loResp = loHttp.PostUrlEncoded(lcEndPoint,loReq)
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    return
endif

// The response is JSON..
loJson = createobject("CkJsonObject")
loJson.Load(loResp.BodyStr)
loJson.EmitCompact = .F.

// If the response status code is not 200, then it failed.
? "Response status code = " + str(loResp.StatusCode)
if (loResp.StatusCode <> 200) then
    ? loJson.Emit()
    ? "Failed."
    release loHttp
    release loReq
    release loJson
    return
endif

// We successfully retrieved an eBay access token.
// The actual access token string can be parsed from the JSON like this:
lcAccessToken = loJson.StringOf("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.
loDtExpire = createobject("CkDateTime")
loDtExpire.SetFromCurrentSystemTime()
loDtExpire.AddSeconds(loJson.IntOf("expires_in"))
loJson.AppendString("expire_time",loDtExpire.GetAsTimestamp(.F.))

// Persist the JSON to a file.
loFac = createobject("CkFileAccess")
llSuccess = loFac.WriteEntireTextFile("qa_data/tokens/ebay.json",loJson.Emit(),"utf-8",.F.)
if (llSuccess <> .T.) then
    ? loFac.LastErrorText
    ? "Failed to save eBay Application token to file."
    release loHttp
    release loReq
    release loJson
    release loDtExpire
    release loFac
    return
endif

? loJson.Emit()
? "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.
// 


release loHttp
release loReq
release loJson
release loDtExpire
release loFac