(PHP Extension) ETrade Renew Access Token

Renews an ETrade OAuth access token.

For more information, see https://apisb.etrade.com/docs/api/authorization/renew_access_token.html

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$http->put_OAuth1(true);
$http->put_OAuthVerifier('');
$http->put_OAuthConsumerKey('ETRADE_CONSUMER_KEY');
$http->put_OAuthConsumerSecret('ETRADE_CONSUMER_SECRET');

// Load the access token previously obtained via the OAuth1 Authorization
$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/etrade.json');
if ($success != true) {
    print 'Failed to load OAuth1 token' . "\n";
    exit;
}

$http->put_OAuthToken($jsonToken->stringOf('oauth_token'));
$http->put_OAuthTokenSecret($jsonToken->stringOf('oauth_token_secret'));

// resp is a CkHttpResponse
$resp = $http->QuickGetObj('https://api.etrade.com/oauth/renew_access_token');
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Make sure a successful response was received.
if ($resp->get_StatusCode() != 200) {
    print $resp->statusLine() . "\n";
    print $resp->header() . "\n";
    print $resp->bodyStr() . "\n";
    exit;
}

// If successful, the resp.BodyStr contains something like this:
// oauth_token=%3TiQRgQCRGPo7Xdk6G8QDSEzX0Jsy6sKNcULcDavAGgU%3D&oauth_token_secret=%7RrC9scEpzcwSEMy4vE7nodSzPLqfRINnTNY4voczyFM%3D
print $resp->bodyStr() . "\n";

$sbRespBody = new CkStringBuilder();
$resp->GetBodySb($sbRespBody);
if ($sbRespBody->ContentsEqual('Access Token has been renewed',false)) {
    // The documentation at https://apisb.etrade.com/docs/api/authorization/renew_access_token.html
    // indicates that the response should be as described above.  However, the response received when
    // trying to refresh a non-expired token was "Access Token has been renewed"
    print 'Keeping the same access token, but it's renewed...' . "\n";
    exit;
}

$hashTab = new CkHashtable();
$hashTab->AddQueryParams($resp->bodyStr());

$accessToken = $hashTab->lookupStr('oauth_token');
$accessTokenSecret = $hashTab->lookupStr('oauth_token_secret');

// The access token + secret is what should be saved and used for
// subsequent REST API calls.
print 'Access Token = ' . $accessToken . "\n";
print 'Access Token Secret = ' . $accessTokenSecret . "\n";

// Save this access token for future calls.
// Just in case we need user_id and screen_name, save those also..
$json = new CkJsonObject();
$json->AppendString('oauth_token',$accessToken);
$json->AppendString('oauth_token_secret',$accessTokenSecret);

$fac = new CkFileAccess();
$fac->WriteEntireTextFile('qa_data/tokens/etrade.json',$json->emit(),'utf-8',false);

print 'Success.' . "\n";

?>