Objective-C

Get eBay Application Token

See more eBay Examples

This example shows how to request an eBay Application token. Objective-C

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <NSString.h>
#import <CkoHttpResponse.h>
#import <CkoJsonObject.h>
#import <CkoDateTime.h>
#import <CkoFileAccess.h>

BOOL success = NO;

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

CkoHttp *http = [[CkoHttp alloc] init];

// 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 = YES;

// 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.
CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
[req AddParam: @"grant_type" value: @"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" value: @"https://api.ebay.com/oauth/api_scope"];

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

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpReq: endPoint request: req response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// The response is JSON..
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: resp.BodyStr];
json.EmitCompact = NO;

// If the response status code is not 200, then it failed.
NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
if ([resp.StatusCode intValue] != 200) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

// We successfully retrieved an eBay access token.
// The actual access token string can be parsed from the JSON like this:
NSString *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.
CkoDateTime *dtExpire = [[CkoDateTime alloc] init];
[dtExpire SetFromCurrentSystemTime];
[dtExpire AddSeconds: [json IntOf: @"expires_in"]];
[json AppendString: @"expire_time" value: [dtExpire GetAsTimestamp: NO]];

// Persist the JSON to a file.
CkoFileAccess *fac = [[CkoFileAccess alloc] init];
success = [fac WriteEntireTextFile: @"qa_data/tokens/ebay.json" fileData: [json Emit] charset: @"utf-8" includePreamble: NO];
if (success != YES) {
    NSLog(@"%@",fac.LastErrorText);
    NSLog(@"%@",@"Failed to save eBay Application token to file.");
    return;
}

NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"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.
//