(Android™) HMRC OAuth2 Access Token

Demonstrates how to get an HMRC OAuth2 access token from a desktop (installed) application or script. This example gets an HMRC MTD VAT read/write access token.

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.

    CkOAuth2 oauth2 = new CkOAuth2();
    boolean success;

    // This should be the port in the localhost callback URL for your app.
    // Important: Make sure the callback URI in your HMRC developer app 
    // is exactly "http://localhost:3017/".  Don't forget the ending "/" char.
    // The callback URL would look like "http://localhost:3017/" if the port number is 3017.

    // IMPORTANT: Don't forget to setup your HMRC application to use the Redirect URI "http://localhost:3017/" as shown
    // here: Configure Redirect URI for HMRC application
    oauth2.put_ListenPort(3017);

    oauth2.put_AuthorizationEndpoint("https://test-api.service.hmrc.gov.uk/oauth/authorize");
    oauth2.put_TokenEndpoint("https://test-api.service.hmrc.gov.uk/oauth/token");

    // Replace these with actual values.
    oauth2.put_ClientId("HMRC-CLIENT-ID");
    oauth2.put_ClientSecret("HMRC-CLIENT-SECRET");

    // The scopes are documented in the HMRC reference documentation for each API.
    // This example gets a read/write access token for the HMRC MTD VAT API.
    oauth2.put_Scope("read:vat write:vat");

    // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    String url = oauth2.startAuth();
    if (oauth2.get_LastMethodSuccess() != true) {
        Log.i(TAG, oauth2.lastErrorText());
        return;
        }

    CkHttp http = new CkHttp();

    // At this point, your application should load the URL in a browser.
    // For example, 
    // in C#: System.Diagnostics.Process.Start(url);
    // in Java: Desktop.getDesktop().browse(new URI(url));
    // in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
    //              wsh.Run url
    // The GitHub account owner would interactively accept or deny the authorization request.

    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...

    // Now wait for the authorization.
    // We'll wait for a max of 120 seconds.
    int numMsWaited = 0;
    while ((numMsWaited < 120000) and (oauth2.get_AuthFlowState() < 3)) {
        oauth2.SleepMs(100);
        numMsWaited = numMsWaited + 100;
        }

    // If there was no response from the browser within 30 seconds, then 
    // the AuthFlowState will be equal to 1 or 2.
    // 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
    // 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
    // In that case, cancel the background task started in the call to StartAuth.
    if (oauth2.get_AuthFlowState() < 3) {
        oauth2.Cancel();
        Log.i(TAG, "No response from the browser!");
        return;
        }

    // Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
    // The possible AuthFlowState values are:
    // 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
    // 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
    // 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
    if (oauth2.get_AuthFlowState() == 5) {
        Log.i(TAG, "OAuth2 failed to complete.");
        Log.i(TAG, oauth2.failureInfo());
        return;
        }

    if (oauth2.get_AuthFlowState() == 4) {
        Log.i(TAG, "OAuth2 authorization was denied.");
        Log.i(TAG, oauth2.accessTokenResponse());
        return;
        }

    if (oauth2.get_AuthFlowState() != 3) {
        Log.i(TAG, "Unexpected AuthFlowState:" + String.valueOf(oauth2.get_AuthFlowState()));
        return;
        }

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

    // Get the full JSON response:
    CkJsonObject json = new CkJsonObject();
    json.Load(oauth2.accessTokenResponse());
    json.put_EmitCompact(false);
    Log.i(TAG, json.emit());

    // The JSON response looks like this:

    // {
    //   "token_type": "Bearer",
    //   "scope": "user_impersonation",
    //   "expires_in": "3599",
    //   "ext_expires_in": "0",
    //   "expires_on": "1524783438",
    //   "not_before": "1524779538",
    //   "resource": "https://mydomain.api.crm.dynamics.com",
    //   "access_token": "...",
    //   "refresh_token": "...",
    //   "id_token": "..."
    // }

    // If an "expires_on" member does not exist, then add the JSON member by
    // getting the current system date/time and adding the "expires_in" seconds.
    // This way we'll know when the token expires.
    if (json.HasMember("expires_on") != true) {
        CkDateTime dtExpire = new CkDateTime();
        dtExpire.SetFromCurrentSystemTime();
        dtExpire.AddSeconds(json.IntOf("expires_in"));
        json.AppendString("expires_on",dtExpire.getAsUnixTimeStr(false));
        }

    Log.i(TAG, json.emit());

    // Save the JSON to a file for future requests.
    CkFileAccess fac = new CkFileAccess();
    fac.WriteEntireTextFile("qa_data/tokens/hmrc.json",json.emit(),"utf-8",false);

  }

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