PureBasic

Google Photos OAuth2 Access Token

See more Google Photos Examples

Demonstrates how to get a Google Photos OAuth2 access token from a desktop application or script. PureBasic

IncludeFile "CkOAuth2.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example 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

    ; For Google 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:3017/
    ; Your app should choose a port not likely not used by any other application.
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://accounts.google.com/o/oauth2/v2/auth")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://www.googleapis.com/oauth2/v4/token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "GOOGLE-CLIENT-ID")
    CkOAuth2::setCkClientSecret(oauth2, "GOOGLE-CLIENT-SECRET")

    CkOAuth2::setCkCodeChallenge(oauth2, 1)
    CkOAuth2::setCkCodeChallengeMethod(oauth2, "S256")

    ; This is a scope for Google Photos.  See https://developers.google.com/photos/library/guides/authentication-authorization
    ; This scope provides read/write access but not sharing.
    CkOAuth2::setCkScope(oauth2, "https://www.googleapis.com/auth/photoslibrary")

    ; Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    url.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Launch the system's default browser navigated to the URL.
    success = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Now wait for the authorization.
    ; We'll wait for a max of 120 seconds.
    numMsWaited.i = 0
    While (numMsWaited < 120000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 100
    Wend

    ; If there was no response from the browser within 120 seconds, then 
    ; the AuthFlowState will be equal to 1 or 2.
    ; 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
    ; 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
    ; In that case, cancel the background task started in the call to StartAuth.
    If CkOAuth2::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
    ; The possible AuthFlowState values are:
    ; 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
    ; 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
    ; 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
    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

    ; Save the full JSON access token response to a file.
    sbJson.i = CkStringBuilder::ckCreate()
    If sbJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbJson,CkOAuth2::ckAccessTokenResponse(oauth2))
    CkStringBuilder::ckWriteFile(sbJson,"qa_data/tokens/googlePhotos.json","utf-8",0)

    ; The saved JSON response looks like this:
    ; {
    ;   "access_token": "ya29.GlamBqWR6cp8lEfJMmTHVEua45912XLKoq4djyHl_Z3CEIzsPLIZkJSGie5oOrbaggy1rjJHn1zW5bjqSesGr5MEYIp9Hx-0CuvjVYf8srg2jeaDMwMACvzemp43",
    ;   "expires_in": 3600,
    ;   "refresh_token": "1/rl6k16nysDl9Bp1EhRH9F1WyRIoiSQAvko49Z4yY694MT5V1QXLj2ibNZGaRgek0",
    ;   "scope": "https://www.googleapis.com/auth/photoslibrary",
    ;   "token_type": "Bearer"
    ; }

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


    CkOAuth2::ckDispose(oauth2)
    CkStringBuilder::ckDispose(sbJson)


    ProcedureReturn
EndProcedure