Swift Requires Chilkat v10.1.2+

Quickbooks OAuth2 in a Desktop App

See more QuickBooks Examples

Demonstrates how to get a QuickBooks OAuth2 access token from a desktop application or script. Swift

func chilkatTest() {
    var success: Bool = false

    //  To further clarify, see OAuth 2.0 Authorization Flow

    //  ------------------------------------------------------------------------------------------------
    //  IMPORTANT: You first need to define an App in the Quickbooks Developer Dashboard.
    //  See How to Create an App in QuickBooks Developer Dashboard
    //  ------------------------------------------------------------------------------------------------

    //  This example is for desktop applicatons (it is not for code that runs on a web server).
    //  You'll need to add a line (or a few lines of code) to popup a web browser that navigates to a URL.

    //  This is the way to initially obtain the OAuth2 access token.  Afterwards it can be 
    //  repeatedly refreshed without user interaction, as shown in this example: Refresh Quickbooks OAuth2 Access Token.

    let oauth2 = CkoOAuth2()!

    //  QuickBooks OAuth2 allows for an "http://localhost:<portNumber>/" callback URL for sandbox testing,
    //  but not for production.

    //  In production, your applicaton must use your own public web server as an intermediate
    //  to receive and forward the redirect to localhost.
    //  See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost

    oauth2.appCallbackUrl = "https://yourwebserver.com/OAuth2.php"
    oauth2.listenPort = 3017

    oauth2.authorizationEndpoint = "https://appcenter.intuit.com/connect/oauth2"
    oauth2.tokenEndpoint = "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"

    //  Replace these with actual values.
    oauth2.clientId = "QUICKBOOKS-CLIENT-ID"
    oauth2.clientSecret = "QUICKBOOKS-CLIENT-SECRET"
    oauth2.useBasicAuth = true
    oauth2.codeChallenge = false

    //  Indicate the desired access.  Possible scopes that can appear in the list are:
    //  com.intuit.quickbooks.accounting:  QuickBooks Online API
    //  com.intuit.quickbooks.payment:  QuickBooks Payments API
    //  openid:  OpenID Connect processing
    //  profile:  user's given and family names
    //  email:  user's email address
    //  phone:  user's phone number
    //  address:  user's physical address
    oauth2.scope = "com.intuit.quickbooks.accounting"

    //  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    var url: String? = oauth2.startAuth()
    if oauth2.lastMethodSuccess == false {
        print("\(oauth2.lastErrorText!)")
        return
    }

    print("url = \(url!)")

    //  Launch the default browser on the system and navigate to the url.
    //  The LaunchBrowser method was added in Chilkat v10.1.2.
    success = oauth2.launchBrowser(url: url)
    if success == false {
        print("\(oauth2.lastErrorText!)")
        return
    }

    //  Wait for the user to approve or deny authorization in the browser.
    var numMsWaited: Int = 0
    while (numMsWaited < 90000) && (oauth2.authFlowState.intValue < 3) {
        oauth2.sleepMs(millisec: 100)
        numMsWaited = numMsWaited + 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.authFlowState.intValue < 3 {
        oauth2.cancel()
        print("No response from the browser!")
        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.authFlowState.intValue == 5 {
        print("OAuth2 failed to complete.")
        print("\(oauth2.failureInfo!)")
        return
    }

    if oauth2.authFlowState.intValue == 4 {
        print("OAuth2 authorization was denied.")
        print("\(oauth2.accessTokenResponse!)")
        return
    }

    if oauth2.authFlowState.intValue != 3 {
        print("Unexpected AuthFlowState:\(oauth2.authFlowState.intValue)")
        return
    }

    //  Save the full JSON access token response to a file.
    let sbJson = CkoStringBuilder()!
    sbJson.append(value: oauth2.accessTokenResponse)
    sbJson.writeFile(path: "qa_data/tokens/qb-access-token.json", charset: "utf-8", emitBom: false)

    //  The full JSON received looks like this:
    //  {
    //    "expires_in": 3600,
    //    "x_refresh_token_expires_in": 8726400,
    //    "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
    //    "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
    //    "token_type": "bearer"
    //  }

    print("OAuth2 authorization granted!")
    print("Access Token = \(oauth2.accessToken!)")

    //  Get the realmId if needed...
    //  See About the QuickBooks REST API Realm ID, also known as Company ID
    var realmId: String? = oauth2.getRedirectRequestParam(paramName: "realmId")
    if oauth2.lastMethodSuccess == true {
        print("realmId: \(realmId!)")
    }
    else {
        print("No realmId was provided.")
    }


}