Java

Refresh HMRC OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to refresh an HMRC access token. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.DateTime;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.OAuth2;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        // See Get HMRC Access Token
        // for sample code showing how to obtain a HMRC access token for desktop apps.

        // It is assumed we previously obtained an OAuth2 access token for HMRC.

        JsonObject jsonToken = new JsonObject();
        try {
            jsonToken.loadFile("qa_data/tokens/hmrc.json");
        } catch (ChilkatException e) {
            System.out.println("Failed to load hmrc.json");
            return;
        }

        // The access token JSON looks something 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": "..."
        // }

        OAuth2 oauth2 = new OAuth2();

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

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

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

        // Send the HTTP POST to refresh the access token..
        try {
            oauth2.refreshAccessToken();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Load the access token response into the json object
        jsonToken.load(oauth2.getAccessTokenResponse());

        // 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 (!jsonToken.hasMember("expires_on")) {
            DateTime dtExpire = new DateTime();
            dtExpire.setFromCurrentSystemTime();
            dtExpire.addSeconds(jsonToken.intOf("expires_in"));
            jsonToken.appendString("expires_on", dtExpire.getAsUnixTimeStr(false));
        }

        // Save the new JSON access token response to a file.
        // The access + refresh tokens contained in this JSON will be needed for the next refresh.
        StringBuilder sbJson = new StringBuilder();
        jsonToken.setEmitCompact(false);
        jsonToken.emitSb(sbJson);
        sbJson.writeFile("qa_data/tokens/hmrc.json", "utf-8", false);

        System.out.println("OAuth2 authorization granted!");
        System.out.println("New Access Token = " + oauth2.getAccessToken());
    }
}