(Visual FoxPro) Get eBay Application Token

This example shows how to request an eBay Application token.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL lnSuccess
LOCAL loHttp
LOCAL loReq
LOCAL lcEndPoint
LOCAL loResp
LOCAL loJson
LOCAL lcAccessToken
LOCAL loDtExpire
LOCAL loFac

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

loHttp = 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.
loHttp.Login = "EBAY_CLIENT_ID"
loHttp.Password = "EBAY_CLIENT_SECRET"
loHttp.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.
loReq = CreateObject('Chilkat.HttpRequest')
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")

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

loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpReq(lcEndPoint,loReq,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    CANCEL
ENDIF

* The response is JSON..
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(loResp.BodyStr)
loJson.EmitCompact = 0

* 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 loResp
    RELEASE loJson
    CANCEL
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('Chilkat.CkDateTime')
loDtExpire.SetFromCurrentSystemTime()
loDtExpire.AddSeconds(loJson.IntOf("expires_in"))
loJson.AppendString("expire_time",loDtExpire.GetAsTimestamp(0))

* Persist the JSON to a file.
loFac = CreateObject('Chilkat.FileAccess')
lnSuccess = loFac.WriteEntireTextFile("qa_data/tokens/ebay.json",loJson.Emit(),"utf-8",0)
IF (lnSuccess <> 1) THEN
    ? loFac.LastErrorText
    ? "Failed to save eBay Application token to file."
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    RELEASE loJson
    RELEASE loDtExpire
    RELEASE loFac
    CANCEL
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 loResp
RELEASE loJson
RELEASE loDtExpire
RELEASE loFac