Xbase++ Requires Chilkat v11.0.0+

Get eBay Application Token

See more eBay Examples

This example shows how to request an eBay Application token. Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oReq
LOCAL cEndPoint
LOCAL oResp
LOCAL oJson
LOCAL cAccessToken
LOCAL oDtExpire
LOCAL oFac

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  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.
oHttp:Login := "EBAY_CLIENT_ID"
oHttp:Password := "EBAY_CLIENT_SECRET"
oHttp:BasicAuth := 1

//  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.
oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "POST"
oReq: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

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

cEndPoint := "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
oReq:ContentType := "application/x-www-form-urlencoded"

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpReq(cEndPoint, oReq, oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    RETURN
ENDIF

//  The response is JSON..
oJson := CreateObject("Chilkat.JsonObject")
oJson:Load(oResp:BodyStr)
oJson:EmitCompact := 0

//  If the response status code is not 200, then it failed.
? "Response status code = " + Str(oResp:StatusCode)
IF (oResp:StatusCode != 200)
    ? oJson:Emit()
    ? "Failed."
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    oJson:destroy()
    RETURN
ENDIF

//  We successfully retrieved an eBay access token.
//  The actual access token string can be parsed from the JSON like this:
cAccessToken := oJson: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.
oDtExpire := CreateObject("Chilkat.CkDateTime")
oDtExpire:SetFromCurrentSystemTime()
oDtExpire:AddSeconds(oJson:IntOf("expires_in"))
oJson:AppendString("expire_time", oDtExpire:GetAsTimestamp(0))

//  Persist the JSON to a file.
oFac := CreateObject("Chilkat.FileAccess")
nSuccess := oFac:WriteEntireTextFile("qa_data/tokens/ebay.json", oJson:Emit(), "utf-8", 0)
IF (nSuccess != 1)
    ? oFac:LastErrorText
    ? "Failed to save eBay Application token to file."
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    oJson:destroy()
    oDtExpire:destroy()
    oFac:destroy()
    RETURN
ENDIF

? oJson: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.
//

oHttp:destroy()
oReq:destroy()
oResp:destroy()
oJson:destroy()
oDtExpire:destroy()
oFac:destroy()