Sample code for 30+ languages & platforms
Zig Requires Chilkat v11.0.0+

QuickBooks - Automatically Refresh Access Token with No User Interaction

See more QuickBooks Examples

Demonstrates how to automaticaly refresh an expired access token and retry the request after a 401 authorization error.

Chilkat Zig Downloads

Zig
const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    // Get our previously obtained OAuth2 access token, which should contain JSON like this:
    // {
    //   "expires_in": 3600,
    //   "x_refresh_token_expires_in": 8726400,
    //   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
    //   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
    //   "token_type": "bearer"
    // }

    const json_token = try chilkat.JsonObject.init();
    defer json_token.deinit();
    try json_token.loadFile("qa_data/tokens/qb-access-token.json");

    const rest = try chilkat.Rest.init();
    defer rest.deinit();

    // Connect using TLS.
    // A single REST object, once connected, can be used for many Quickbooks REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    const b_auto_reconnect = true;
    rest.connect("sandbox-quickbooks.api.intuit.com", 443, true, b_auto_reconnect) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    const sb_auth = try chilkat.StringBuilder.init();
    defer sb_auth.deinit();
    sb_auth.append("Bearer ") catch {};
    sb_auth.append(try json_token.stringOf(alloc, "access_token")) catch {};
    rest.setAuthorization(try sb_auth.getAsString(alloc));

    rest.addHeader("Accept", "application/json") catch {};
    rest.setAllowHeaderFolding(false);

    // The company ID is 123146096291789
    // The employee ID is 58
    var response_body: [:0]const u8 = rest.fullRequestNoBody(alloc, "GET", "/v3/company/123146096291789/employee/58?minorversion=45") catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    // If we get a 401 authorization error, then it's likely because the access token expired.
    // We can automatically refresh it without interaction from the user.
    if (rest.getResponseStatusCode() == 401) {
        const oauth2 = try chilkat.OAuth2.init();
        defer oauth2.deinit();

        oauth2.setTokenEndpoint("https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer");

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

        // Get the "refresh_token"
        oauth2.setRefreshToken(try json_token.stringOf(alloc, "refresh_token"));

        // Send the HTTP POST to refresh the access token..
        oauth2.refreshAccessToken() catch {
            std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
            return;
        };

        std.debug.print("New access token: {s}\n", .{try oauth2.getAccessToken(alloc)});

        // Update the JSON with the new tokens.
        json_token.updateString("access_token", try oauth2.getAccessToken(alloc)) catch {};

        // 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.
        const sb_json = try chilkat.StringBuilder.init();
        defer sb_json.deinit();
        json_token.setEmitCompact(false);
        json_token.emitSb(sb_json) catch {};
        sb_json.writeFile("qa_data/tokens/qb-access-token.json", "utf-8", false) catch {};

        std.debug.print("OAuth2 token refreshed!\n", .{});
        std.debug.print("New Access Token = {s}\n", .{try oauth2.getAccessToken(alloc)});

        sb_auth.clear();
        sb_auth.append("Bearer ") catch {};
        sb_auth.append(try oauth2.getAccessToken(alloc)) catch {};
        rest.setAuthorization(try sb_auth.getAsString(alloc));

        // Now retry the request with the refreshed access token...
        response_body = rest.fullRequestNoBody(alloc, "GET", "/v3/company/123146096291789/employee/58?minorversion=45") catch {
            std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
            return;
        };
    }

    // We should expect a 200 response if successful.
    if (rest.getResponseStatusCode() != 200) {
        std.debug.print("Request Header: \n", .{});
        std.debug.print("{s}\n", .{try rest.getLastRequestHeader(alloc)});
        std.debug.print("----\n", .{});
        std.debug.print("Response StatusCode = {d}\n", .{rest.getResponseStatusCode()});
        std.debug.print("Response StatusLine: {s}\n", .{try rest.getResponseStatusText(alloc)});
        std.debug.print("Response Header:\n", .{});
        std.debug.print("{s}\n", .{try rest.getResponseHeader(alloc)});
        std.debug.print("{s}\n", .{response_body});
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.load(response_body) catch {};

    // These will be used for parsing date/time strings..
    const dtime = try chilkat.DateTime.init();
    defer dtime.deinit();
    const b_local_time = true;

    // Show the JSON.
    json.setEmitCompact(false);
    std.debug.print("{s}\n", .{try json.emit(alloc)});

    // Get some information from the JSON..
    std.debug.print("Name: {s}\n", .{try json.stringOf(alloc, "Employee.DisplayName")});
    std.debug.print("Id: {s}\n", .{try json.stringOf(alloc, "Employee.Id")});
    std.debug.print("City: {s}\n", .{try json.stringOf(alloc, "Employee.PrimaryAddr.City")});
    std.debug.print("PostalCode: {s}\n", .{try json.stringOf(alloc, "Employee.PrimaryAddr.PostalCode")});

    // Load the CreateTime into a CkDateTime...
    dtime.setFromTimestamp(try json.stringOf(alloc, "Employee.MetaData.CreateTime")) catch {};
    const dt = try chilkat.DtObj.init();
    defer dt.deinit();
    dtime.toDtObj(b_local_time, dt);

    std.debug.print("{d}/{d}/{d}  {d}:{d}\n", .{ dt.getMonth(), dt.getDay(), dt.getYear(), dt.getHour(), dt.getMinute() });

    std.debug.print("Success.\n", .{});

    // Use this online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    // ------------------------------------------------------
    // The JSON response looks like this:

    // {
    //   "Employee": {
    //     "SSN": "XXX-XX-XXXX",
    //     "PrimaryAddr": {
    //       "Id": "116",
    //       "Line1": "45 N. Elm Street",
    //       "City": "Middlefield",
    //       "CountrySubDivisionCode": "CA",
    //       "PostalCode": "93242"
    //     },
    //     "BillableTime": false,
    //     "domain": "QBO",
    //     "sparse": false,
    //     "Id": "98",
    //     "SyncToken": "0",
    //     "MetaData": {
    //       "CreateTime": "2015-07-24T09:34:35-07:00",
    //       "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
    //     },
    //     "GivenName": "Bill",
    //     "FamilyName": "Miller",
    //     "DisplayName": "Bill Miller",
    //     "PrintOnCheckName": "Bill Miller",
    //     "Active": true,
    //     "PrimaryPhone": {
    //       "FreeFormNumber": "234-525-1234"
    //     }
    //   },
    //   "time": "2015-07-24T09:35:54.805-07:00"
    // }
}