PureBasic

Yahoo Mail Refresh OAuth2 Access Token

See more Yahoo Mail Examples

Demonstrates how to refresh an OAuth2 Yahoo Mail access token. PureBasic

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

Procedure ChilkatExample()

    success.i = 0

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

    ; It is assumed we previously obtained an OAuth2 access token.
    ; This example loads the JSON access token file 
    ; saved by this example: Get Yahoo Mail OAuth2 Access Token

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

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/yahooMail.json")
    If success <> 1
        Debug "Failed to load googleSheets.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; The access token JSON looks like this:

    ; {
    ;   "access_token": "kCVQdnOdul...LHucA--",
    ;   "refresh_token": "AIenVWETSo0jklFBVkPS8vVm8E.Dj9ToRG.xDbDYmZ55WIs5t6CZhDkD",
    ;   "expires_in": 3600,
    ;   "token_type": "bearer",
    ;   "xoauth_yahoo_guid": "HGDQCVF6JB4YDOWHITPJFBHCWA"
    ; }

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

    ; See Step 5 at https://developer.yahoo.com/oauth2/guide/flows_authcode/
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://api.login.yahoo.com/oauth2/get_token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "CLIENT_ID")
    CkOAuth2::setCkClientSecret(oauth2, "CLIENT_SECRET")

    ; Get the "refresh_token"
    CkOAuth2::setCkRefreshToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"refresh_token"))

    ; Send the HTTP POST to refresh the access token..
    success = CkOAuth2::ckRefreshAccessToken(oauth2)
    If success <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; The response contains a new access token, but we must keep
    ; our existing refresh token for when we need to refresh again in the future.
    CkJsonObject::ckUpdateString(jsonToken,"access_token",CkOAuth2::ckAccessToken(oauth2))

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

    CkJsonObject::setCkEmitCompact(jsonToken, 0)
    CkJsonObject::ckEmitSb(jsonToken,sbJson)
    CkStringBuilder::ckWriteFile(sbJson,"qa_data/tokens/yahooMail.json","utf-8",0)

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


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


    ProcedureReturn
EndProcedure