Swift

Vonage UC Extend OAuth2

See more OAuth2 Examples

Get an OAuth2 access token for a desktop application for Vonage. Swift

func chilkatTest() {
    var success: Bool = false

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

    let oauth2 = CkoOAuth2()!

    // This should be the port in the localhost callback URL for your app.  
    // The callback URL would look like "http://localhost:3800/" if the port number is 3017.
    oauth2.listenPort = 3800

    oauth2.authorizationEndpoint = "https://api.vonage.com/authorize"
    oauth2.tokenEndpoint = "https://api.vonage.com/token"

    // Replace these with actual values.
    oauth2.clientId = "CLIENT_ID"
    oauth2.clientSecret = "CLIENT_SECRET"
    oauth2.codeChallenge = false

    oauth2.scope = "openid"

    // 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 != true {
        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
    }

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

    // Get the full JSON response:
    let json = CkoJsonObject()!
    json.load(json: oauth2.accessTokenResponse)
    json.emitCompact = false
    print("\(json.emit()!)")

    // The JSON response looks like this:

    // {
    //   "access_token": "XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX",
    //   "refresh_token": "XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX",
    //   "scope": "openid",
    //   "id_token": "eyJ4NXQiOiJNem ... hA9tbDCiQRhdI4T0",
    //   "token_type": "Bearer",
    //   "expires_in": 3600
    // }

    // Save the JSON to a file for future requests.
    let fac = CkoFileAccess()!
    fac.writeEntireTextFile(path: "qa_data/tokens/vonage_uc_extend.json", fileData: json.emit(), charset: "utf-8", includePreamble: false)

}