(PHP ActiveX) Refresh a Xero OAuth2 Access Token

Refreshes a Xero OAuth2 access token. When an access token expires (after 1 hour), you will received a 401 status code indicating failure. When that happens, your application can run this code to refresh the access token, and then retry the request using the new access token. Refreshing an access token does not need user interaction (i.e. does not need to display a browser to have the user interactive authorize access).

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// It is assumed we previously obtained an OAuth2 access token.
// This example loads the JSON access token file 
// saved by this example: Get Xero OAuth2 Access Token

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonToken = new COM("Chilkat.JsonObject");
$success = $jsonToken->LoadFile('qa_data/tokens/xero-access-token.json');
if ($success != 1) {
    print 'Failed to load xero-access-token.json' . "\n";
    exit;
}

// The access token JSON looks like this:

// {
//   "id_token": "eyJhbGci...dqRs3MctS_g",
//   "access_token": "eyJhbGci...sUoAhoQ",
//   "expires_in": 1800,
//   "token_type": "Bearer",
//   "refresh_token": "2f77b...bfc2ee16f",
//   "scope": "openid profile email accounting.transactions accounting.settings payroll.employees offline_access"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.OAuth2')
$oauth2 = new COM("Chilkat.OAuth2");

$oauth2->TokenEndpoint = 'https://identity.xero.com/connect/token';

// Replace these with actual values.
$oauth2->ClientId = 'XERO_APP_OAUTH2_CLIENT_ID';
$oauth2->ClientSecret = 'XERO_APP_OAUTH2_CLIENT_SECRET';
$oauth2->UseBasicAuth = 1;

// Get the "refresh_token"
$oauth2->RefreshToken = $jsonToken->stringOf('refresh_token');

// Send the HTTP POST to refresh the access token..
$success = $oauth2->RefreshAccessToken();
if ($success != 1) {
    print $oauth2->LastErrorText . "\n";
    exit;
}

print $oauth2->AccessTokenResponse . "\n";

// The response contains a new access token and refresh token.
// Update the JSON and re-save to the token file.
$jsonToken->UpdateString('access_token',$oauth2->AccessToken);
$jsonToken->UpdateString('refresh_token',$oauth2->RefreshToken);

// Save the new JSON access token response to a file.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbJson = new COM("Chilkat.StringBuilder");
$jsonToken->EmitCompact = 0;
$jsonToken->EmitSb($sbJson);
$sbJson->WriteFile('qa_data/tokens/xero-access-token.json','utf-8',0);

print 'OAuth2 authorization granted!' . "\n";
print 'New Access Token = ' . $oauth2->AccessToken . "\n";

?>