(Android™) 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 Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkJsonObject jsonToken = new CkJsonObject();
    boolean success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json");
    if (success != true) {
        Log.i(TAG, "Failed to load xero-access-token.json");
        return;
        }

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

    CkOAuth2 oauth2 = new CkOAuth2();

    oauth2.put_TokenEndpoint("https://identity.xero.com/connect/token");

    // Replace these with actual values.
    oauth2.put_ClientId("XERO_APP_OAUTH2_CLIENT_ID");
    oauth2.put_ClientSecret("XERO_APP_OAUTH2_CLIENT_SECRET");
    oauth2.put_UseBasicAuth(true);

    // Get the "refresh_token"
    oauth2.put_RefreshToken(jsonToken.stringOf("refresh_token"));

    // Send the HTTP POST to refresh the access token..
    success = oauth2.RefreshAccessToken();
    if (success != true) {
        Log.i(TAG, oauth2.lastErrorText());
        return;
        }

    Log.i(TAG, oauth2.accessTokenResponse());

    // 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.
    CkStringBuilder sbJson = new CkStringBuilder();
    jsonToken.put_EmitCompact(false);
    jsonToken.EmitSb(sbJson);
    sbJson.WriteFile("qa_data/tokens/xero-access-token.json","utf-8",false);

    Log.i(TAG, "OAuth2 authorization granted!");
    Log.i(TAG, "New Access Token = " + oauth2.accessToken());

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}