PureBasic

GeoOp OAuth2 Authorisation Code Grant (Public App)

See more OAuth2 Examples

Demonstrates how to get an access token for a GeoOp Third-Party Public Application using the Authorisation Code Grant flow. PureBasic

IncludeFile "CkOAuth2.pb"
IncludeFile "CkFileAccess.pb"

Procedure ChilkatExample()

    success.i = 0

    ; It requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; This should match the Site URL configured for your GeoOp (non-Server) Application, such as "http://localhost:3017/"
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://login.geoop.com/oauth2/code")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://login.geoop.com/oauth2/token")

    ; Replace the client ID with an actual value.
    CkOAuth2::setCkClientId(oauth2, "GEOOP-APPLICATION-ID")
    ; The ClientSecret should remain empty for a GeoOp public application
    CkOAuth2::setCkClientSecret(oauth2, "")

    ; We need a few special settings for GeoOp
    CkOAuth2::setCkScope(oauth2, "default")
    CkOAuth2::setCkCodeChallenge(oauth2, 0)
    ; Setting LocalHost equal to "none" prevents the "redirect_uri" query param from being sent in the initial HTTP request.
    ; Note: The GeoOp Application should still have a redirect URL specified as "http://localhost:3017/", where the port
    ; number matches the ListenPort above.
    CkOAuth2::setCkLocalHost(oauth2, "none")

    ; Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    url.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Launch the default browser on the system and navigate to the url.
    ; The LaunchBrowser method was added in Chilkat v10.1.2.
    success = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Wait for the user to approve or deny authorization in the browser.
    numMsWaited.i = 0
    While (numMsWaited < 90000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 100
    Wend

    ; 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 CkOAuth2::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; 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 CkOAuth2::ckAuthFlowState(oauth2) = 5
        Debug "OAuth2 failed to complete."
        Debug CkOAuth2::ckFailureInfo(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) = 4
        Debug "OAuth2 authorization was denied."
        Debug CkOAuth2::ckAccessTokenResponse(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "OAuth2 authorization granted!"
    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    ; Save the entire JSON response, which includes the access token, for future calls.
    ; The JSON AccessTokenResponse looks like this:
    ; {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":984236}

    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/geoop.json",CkOAuth2::ckAccessTokenResponse(oauth2),"utf-8",0)

    Debug "Success."


    CkOAuth2::ckDispose(oauth2)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure