PowerBuilder

Get eBay Application Token

See more eBay Examples

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

integer li_rc
integer li_Success
oleobject loo_Http
oleobject loo_Req
string ls_EndPoint
oleobject loo_Resp
oleobject loo_Json
string ls_AccessToken
oleobject loo_DtExpire
oleobject loo_Fac

li_Success = 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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
loo_Http.Login = "EBAY_CLIENT_ID"
loo_Http.Password = "EBAY_CLIENT_SECRET"
loo_Http.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.
loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

loo_Req.HttpVerb = "POST"
loo_Req.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

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

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

loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

li_Success = loo_Http.HttpReq(ls_EndPoint,loo_Req,loo_Resp)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    destroy loo_Resp
    return
end if

// The response is JSON..
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(loo_Resp.BodyStr)
loo_Json.EmitCompact = 0

// If the response status code is not 200, then it failed.
Write-Debug "Response status code = " + string(loo_Resp.StatusCode)
if loo_Resp.StatusCode <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_Req
    destroy loo_Resp
    destroy loo_Json
    return
end if

// We successfully retrieved an eBay access token.
// The actual access token string can be parsed from the JSON like this:
ls_AccessToken = loo_Json.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.
loo_DtExpire = create oleobject
li_rc = loo_DtExpire.ConnectToNewObject("Chilkat.CkDateTime")

loo_DtExpire.SetFromCurrentSystemTime()
loo_DtExpire.AddSeconds(loo_Json.IntOf("expires_in"))
loo_Json.AppendString("expire_time",loo_DtExpire.GetAsTimestamp(0))

// Persist the JSON to a file.
loo_Fac = create oleobject
li_rc = loo_Fac.ConnectToNewObject("Chilkat.FileAccess")

li_Success = loo_Fac.WriteEntireTextFile("qa_data/tokens/ebay.json",loo_Json.Emit(),"utf-8",0)
if li_Success <> 1 then
    Write-Debug loo_Fac.LastErrorText
    Write-Debug "Failed to save eBay Application token to file."
    destroy loo_Http
    destroy loo_Req
    destroy loo_Resp
    destroy loo_Json
    destroy loo_DtExpire
    destroy loo_Fac
    return
end if

Write-Debug loo_Json.Emit()
Write-Debug "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.
// 


destroy loo_Http
destroy loo_Req
destroy loo_Resp
destroy loo_Json
destroy loo_DtExpire
destroy loo_Fac