Zig Requires Chilkat v10.1.2+

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. Zig

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

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

    // For more information about the OAuth2, see OAuth 2.0 Authorization Flow

    const oauth2 = try chilkat.OAuth2.init();
    defer oauth2.deinit();

    // For Xero OAuth2, set the listen port equal to the port used
    // in the Authorized Redirect URL for the Client ID.
    // For example, in this case the Authorized Redirect URL would be http://localhost:55568/
    // Your app should choose a port not likely not used by any other application.
    // See Xero OAuth2 for Desktop Apps for more information.
    oauth2.setListenPort(55568);

    oauth2.setAuthorizationEndpoint("https://login.xero.com/identity/connect/authorize");
    oauth2.setTokenEndpoint("https://identity.xero.com/connect/token");

    // Replace these with actual values.
    oauth2.setClientId("XERO_APP_OAUTH2_CLIENT_ID");
    oauth2.setClientSecret("XERO_APP_OAUTH2_CLIENT_SECRET");
    oauth2.setUseBasicAuth(true);

    // See https://developer.xero.com/documentation/oauth2/scopes for a complete list of scopes.
    // You will need to change the scopes depending on what access is needed..
    oauth2.setScope("openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access");

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    const url = oauth2.startAuth(alloc) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("url = {s}\n", .{url});

    // Launch the default browser on the system and navigate to the url.
    // The LaunchBrowser method was added in Chilkat v10.1.2.
    oauth2.launchBrowser(url) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    // Wait for the user to approve or deny authorization in the browser.
    var num_ms_waited: i32 = 0;
    while ((num_ms_waited < 90000) and (oauth2.getAuthFlowState() < 3)) {
        oauth2.sleepMs(100);
        num_ms_waited = num_ms_waited + 100;
    }

    // If the browser does not respond within the specified time, AuthFlowState will be:
    //
    // 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
    // 2: Waiting for Final Response - The thread is awaiting the final access token response.
    // In either case, cancel the background task initiated by StartAuth.

    if (oauth2.getAuthFlowState() < 3) {
        oauth2.cancel() catch {};
        std.debug.print("No response from the browser!\n", .{});
        return;
    }

    // Check AuthFlowState to determine if authorization was granted, denied, or failed:
    //
    // 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
    // 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
    // 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

    if (oauth2.getAuthFlowState() == 5) {
        std.debug.print("OAuth2 failed to complete.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getFailureInfo(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() == 4) {
        std.debug.print("OAuth2 authorization was denied.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getAccessTokenResponse(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() != 3) {
        std.debug.print("Unexpected AuthFlowState:{d}\n", .{oauth2.getAuthFlowState()});
        return;
    }

    // Save the full JSON access token response to a file.
    const sb_json = try chilkat.StringBuilder.init();
    defer sb_json.deinit();
    sb_json.append(try oauth2.getAccessTokenResponse(alloc)) catch {};
    sb_json.writeFile("qa_data/tokens/xero-access-token.json", "utf-8", false) catch {};

    // The saved JSON response looks like this:

    //     {
    //      "access_token": "...",
    //      "token_type": "Bearer",
    //      "expires_in": 3600,
    //      "refresh_token": "..."
    //     }
    //
    std.debug.print("OAuth2 authorization granted!\n", .{});
    std.debug.print("Access Token = {s}\n", .{try oauth2.getAccessToken(alloc)});
}