Pascal (Lazarus/Delphi)

Get eBay Application Token

See more eBay Examples

This example shows how to request an eBay Application token. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.CkDateTime,
  Chilkat.FileAccess,
  Chilkat.HttpResponse,
  Chilkat.HttpRequest,
  Chilkat.JsonObject,
  Chilkat.Http;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  http: THttp;
  req: THttpRequest;
  endPoint: string;
  resp: THttpResponse;
  json: TJsonObject;
  accessToken: string;
  dtExpire: TCkDateTime;
  fac: TFileAccess;

begin
  success := False;

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

  http := THttp.Create;

  //  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.BasicAuth := 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.
  req := THttpRequest.Create;
  req.HttpVerb := 'POST';
  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

  req.AddParam('scope','https://api.ebay.com/oauth/api_scope');

  endPoint := 'https://api.sandbox.ebay.com/identity/v1/oauth2/token';
  req.ContentType := 'application/x-www-form-urlencoded';

  resp := THttpResponse.Create;
  success := http.HttpReq(endPoint,req,resp);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  //  The response is JSON..
  json := TJsonObject.Create;
  json.Load(resp.BodyStr);
  json.EmitCompact := False;

  //  If the response status code is not 200, then it failed.
  WriteLn('Response status code = ' + resp.StatusCode);
  if (resp.StatusCode <> 200) then
    begin
      WriteLn(json.Emit());
      WriteLn('Failed.');
      Exit;
    end;

  //  We successfully retrieved an eBay access token.
  //  The actual access token string can be parsed from the JSON like this:
  accessToken := 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.
  dtExpire := TCkDateTime.Create;
  dtExpire.SetFromCurrentSystemTime();
  dtExpire.AddSeconds(json.IntOf('expires_in'));
  json.AppendString('expire_time',dtExpire.GetAsTimestamp(False));

  //  Persist the JSON to a file.
  fac := TFileAccess.Create;
  success := fac.WriteEntireTextFile('qa_data/tokens/ebay.json',json.Emit(),'utf-8',False);
  if (success <> True) then
    begin
      WriteLn(fac.LastErrorText);
      WriteLn('Failed to save eBay Application token to file.');
      Exit;
    end;

  WriteLn(json.Emit());
  WriteLn('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.
  //  


  http.Free;
  req.Free;
  resp.Free;
  json.Free;
  dtExpire.Free;
  fac.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.